Docgen of defaulted properties in a SFC (Typescript 3)

[ibrambe]

The default column only specifies if a property is required or not, it doesn't take defaulted properties into account. I known I can work around this with Button.defaultProps = {}, but this shouldn't be required anymore.

import * as React from "react";

interface ButtonProps {
    children: React.ReactNode,
    /** More information about the disabled property */
    disabled?: boolean
}

/**
 * A general purpose button.
 */
export default function Button({children, disabled = false}: ButtonProps) {
    return <button disabled={disabled}>{children}</button>;
}

Output:

Expected output:

[poteirard]

Another workaround in case you don't know is:

/**
  * More information about the disabled property
  * @default false
  */

But I agree it will be definitely useful to have this feature. 👍

[fmal]

@ibrambe would setting Button.defaultProps have an expected effect? From my experimentation with defaultProps property on the function, defaulted properties aren't taken into account either.

[Juan-Gargiulo]

Ị̣'m using storybook, and in my case, the solution was place withInfo decorator in first place, before other decorators in the storie declaration.

[reneolivo]

Really interested in this. I'd be fine with declaring default values using defaultProps.