reactjs / reactjs/react.dev

Adding description to types

未關閉
#6,564 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
JavaScript
星號
11.8k
分支
7.9k
平均合併
1 天 11 小時
30 天內合併 PR
11

描述

Can we add types description for React types, that can be supported for docs generators?

For example we use next inheritance:

import React, { ButtonHTMLAttributes, FC } from 'react'

export interface ActionIconProps
  extends Pick<
      ButtonHTMLAttributes<HTMLButtonElement>,
      | 'title'
      | 'tabIndex'
      | 'className'
      | 'style'
      | 'aria-label'
      | 'aria-haspopup'
      | 'aria-expanded'
      | 'onClick'
      | 'onKeyDown'
      | 'onMouseDown'
      | 'onFocus'
      | 'onBlur'
      | 'disabled'
    > {
  /** My custom property */
  myProp: string
}

and in doc system like Storybook it generated without description.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先,在文件產生器或 Storybook 設定中重現 issue 中的 ActionIconProps 範例。追蹤繼承的 React 型別和 /** My custom property */ 描述是如何處理的;完成的標準是產生的文件保留這些繼承屬性和自訂屬性的描述。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
react, storybook, typescript
領域
documentation, tooling
Issue 類型
功能
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
需要釐清
新手友好度
32/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。