reactjs / reactjs/react-docgen
Support for compound components
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.8k
- Forks
- 316
- Merge medio
- 5 h 7 min
- PR fusionados (30 d)
- 4
Descripción
I've been playing around with the latest beta, and while it works well for many cases, I could not get it to work with compound components.
A compound component generally looks like this:
<Compound foo>
<Compound.Child />
</Compound>
I'm defining it as follows:
import React from 'react';
import type { PolymorphicComponent } from '~/utils';
const ParentComponent = React.forwardRef((props, ref) => {
return (/* ... */)
}) as PolymorphicComponent<'div', ParentOwnProps>;
type ParentOwnProps = {
/** foo prop */
foo?: boolean;
};
const ChildComponent = React.forwardRef((props, ref) => {
return (/* ... */)
}) as PolymorphicComponent<'div', ChildOwnProps>;
type ChildOwnProps = {
/** bar prop */
bar?: string;
};
/** description for main component */
export const Compound = Object.assign(ParentComponent, {
/** description for subcomponent */
Child: ChildComponent,
});
export default Compound;
I would guess that react-docgen would need to support a few different things here:
- using the types that are inferred by props (in this case through
PolymorphicComponentutility). related: #590 - detecting that these multiple components are exported through a single
Object.assigndeclaration and reading jsdoc from there
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando cómo se gestionan las props inferidas por TypeScript y las declaraciones de Object.assign, usando el ejemplo PolymorphicComponent y el issue relacionado #590 como puntos de entrada. Se considerará terminado cuando se detecten las exportaciones compuestas y se lean correctamente las descripciones JSDoc del padre y del hijo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- documentation, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100