v3.0.0-beta12

New

Support for "unwrapping" $Exact<...> and $ReadOnly<...> type annotations. Example:

type Props = $ReadOnly<{
  foo: string,
}>;

v3.0.0-beta11

BugFixes

• Handle Logical and Conditional Expressions (#245)
• Added post-processing step for documentation (#227)
• Handle array shorthand notation (#251)
• Fix cycles in flow type detection (#252)
• Get displayName from variable if nothing else found

v2.20.1

BugFixes

• Handle Logical and Conditional Expressions (#245)
• Added post-processing step for documentation (#227)
• Handle array shorthand notation (#251)
• Fix cycles in flow type detection (#252)
• Get displayName from variable if nothing else found

v3.0.0-beta9

(merged changes released in v2.20.0)

New

See v2.20.0.

• Update babylon to latest beta. This allows a lot new syntax proposal which were added to babylon (see babylon changes)

• Enable more babylon plugins (#220)

  Enables the following new plugins in babylon:

  • classPrivateProperties
  • classPrivateMethods
  • numericSeparator
  • optionalChaining
  • importMeta
  • bigInt
  • optionalCatchBinding
  • throwExpressions
  • pipelineOperator
  • nullishCoalescingOperator

---

You can install this version via npm install react-docgen@next.

v2.20.0

New

• Add support for typeof types and React.* types (#224)

  Adds support for all the types described in the react flow docs

• Resolve flow $Keys<> to union type (#225)

  const CONTENTS = {
    'apple': '🍎',
    'banana': '🍌',
  };
  type Props = {
    fruit: $Keys<typeof CONTENTS>,
  };

v3.0.0-beta8

(cherry picked changes released in v2.19.0)

New

See v2.19.0.

Fixed

• See v2.19.0.

• Flow: Function type definitions without parameter names are now supported. For example:

  type Props = {
    callback: (string) => void,
  }
  

  In such a case the parameter name will simply be empty. See the commit ( #218 ) for an example of the output. Thank you @odinuge!

Other

• See v2.19.0.
• getMemberValuePath now understands TaggedTemplateExpressions. This is used by @Jmeyering's custom annotation resolver. Check it out at /~https://github.com/Jmeyering/react-docgen-annotation-resolver ! Thank you @Jmeyering!

---

You can install this version via npm install react-docgen@next.

v2.19.0

New

• The names of class declarations and function declarations are now used as displayNames (3f22b3c).

• In classes, static get propTypes(){} is now inspected for propTypes. I.e. instead of

  class MyComponent extends React.Component {}
  
  MyComponent.propTypes = {
    disabled: PropTypes.boolean,
  };

  you can now write

  class MyComponent extends React.Component {
    static get propTypes() {
      return {
        disabled: PropTypes.boolean,
      };
    }
  }

  (23aa0fe)

Other

• resolveToModule also resolvesJSXIdentifiers now (2c6e55a)

v3.0.0-beta7

(cherry picked changes released in v2.18.0)

New

See v2.18.0.

Fixed

See v2.18.0.

Other

See v2.18.0.

• Upgraded babylon to v7.0.0-beta20.

---

You can install this version via npm install react-docgen@next.

v2.18.0

New

• Add support for flow >=0.53 and the new react definitions (#209).
• Resolve Object.keys in PropType.oneOf() (#211).
  For example:

  Component.propTypes = { foo: PropTypes.oneOf(Object.keys({ a: 1, b: 2 }))};
  // react-docgen will now correctly extract the type of foo being "a" or "b"

v3.0.0-beta6

(cherry picked changes released in v2.17.0)

New

See v2.17.0.

Fixed

See v2.17.0.

Other

See v2.17.0.

• Upgraded babylon to v7.0.0-beta17.

---

You can install this version via npm install react-docgen@next.