react-docgen icon indicating copy to clipboard operation
react-docgen copied to clipboard

The enum value of oneOf doesn't recognize description.

Open xiaoshuangLi opened this issue 6 years ago • 0 comments

Hi,react-docgen does't recognize description for oneOf enum value.Sometimes enum value will make people so confused.It's good to show the comment in description.

Example Component

import React, { Component } from 'react'
import PropTypes from 'prop-types'

class Box extends Component {
  render() {
    return <div>box</div>
  }
}

Box.propTypes = {
  /** 排列 */
  flexDirection: PropTypes.oneOf([
    /** 横向 */
    'row',
    /** 纵向 */
    'column',
  ]),
}

export default Box;

Output Docgen

The comment "横向, 纵向" doesn't show in description.

{
  "description": "",
  "displayName": "Box",
  "methods": [],
  "props": {
    "name": {
      "flexDirection": {
        "defaultValue": {
          "value": "'column'",
          "computed": false
        },
        "type": {
          "name": "enum",
          "value": [{
            "value": "'row'",
            "computed": false
          }, {
            "value": "'column'",
            "computed": false
          }]
        },
        "required": false,
        "description": "排列"
      }
    }
  }
}

xiaoshuangLi avatar Jul 18 '19 09:07 xiaoshuangLi