Addon-docs: Exclude defaultProps from source

It would be great if (if not already available) there was an option to exclude defaultProps from the source output.

Button.tsx

...
Button.defaultProps = {
  disabled: false,
  type: "button",
  block: false,
};
...

Button.stories.mdx

...
<Preview>
  <Story name="button-variant-secondary">
    <Button variant="secondary">Secondary</Button>
  </Story>
</Preview>
...

current behavior of addon-docs source code

<Button
  block={false}
  disabled={false}
  type="button"
  variant="secondary"
>
  Secondary
</Button>

desired behavior

<Button
  variant="secondary"
>
  Secondary
</Button>

[zeckdude]

@shilman @Lueton This is actually possible in Storybook 6.0. As you can see in jsxDecorator.tsx, it is using the reactElementToString method from the react-element-to-jsx-string package. If you check their options, they accept a showDefaultProps property, which when set to false omits the default props in the JSX.

In my opinion, I feel like storybook should have the showDefaultProps option set to false by default and then let the individual components or stories change it when they want it to show. Thoughts on that @shilman?

For now though, you can just use the parameters.jsx object which gets passed to the reactElementToString method and therefore stops the default props from showing.

Note: This is the CSF style

export default {
  title: 'Example/Container',
  component: Container,
  parameters: {
    jsx: {
      showDefaultProps: false
    },
  }
};

[shilman]

Ta-da!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.1.0-beta.2 containing PR #13003 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb upgrade --prerelease

Closing this issue. Please re-open if you think there’s still more to do.