Can I "get" the intended HTML element to be rendered?
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- react, typescript
调研方向
未指定文件、测试或入口点；首先定位用于提取 React 组件元数据的 docgen 解析器或 API，以及其现有的测试覆盖率。完成的标准是：在已记录的 prop 信息旁暴露渲染后的原生 HTML 标签，并有覆盖率证明 h1 情况。
由索引模型根据 Issue 内容生成。
描述
I would like to document both the props and the HTML element that a react component plans on rendering:
const MyComponent = ({ foo, bar, ...restProps }) => <h1 foo={ foo } bar={bar} {...restProps } />;
MyComponent.propTypes = {
foo: PropTypes.string,
bar: PropTypes.number,
}
In the above example I want to be able to document:
- The props stated in propTypes
- The "native" HTML props that would be valid for an
h1element.
In the docs i wanna say:
"here are the explicitly set props and this component also takes all valid props for HTMLHeadingElement"
Is it possible for us to get the h1 tag from docgen so we can associate that component's documentation with its html tag?
- 主要语言
- TypeScript
- 星标
- 3.8k
- 派生
- 316
- 平均合并
- 2 小时 29 分钟
- 30 天内合并 PR
- 5
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
reactjs/react-docgen 的其他 Issue
-
Support Babel 8 in babelParser (loadPartialConfigSync)可能已有人在做 @Stanzilla 于 82 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
reactjs/react-docgen#1102 ·
-
难度 5/5 一周以上 新手友好度 20/100
reactjs/react-docgen#1005 · 4 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 48/100
reactjs/react-docgen#997 ·
-
难度 3/5 1-2 天 新手友好度 42/100
reactjs/react-docgen#994 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 25/100
reactjs/react-docgen#982 · 2 条评论 ·
查看 reactjs/react-docgen 的全部 Issue
相似的 Issue
-
bug ready-for-agent
难度 2/5 1-3 小时 新手友好度 78/100
sleeyax/paseo-plugins#112 ·
维护者通常 2 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
rossoctl/serverless-harness#428 ·
-
难度 2/5 1-3 小时 新手友好度 74/100
typesense/typesense-js#376 ·
-
ready sonnet zone:app
难度 2/5 1-3 小时 新手友好度 92/100
wheresrhys/totf#1103 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
prime-radiant-inc/evener#3726 ·
维护者通常 1 天内回复