Storybook: Especificar una propTable aún genera dos documentos de prop

Creado en 22 abr. 2017  ·  3Comentarios  ·  Fuente: storybookjs/storybook

Edición de FarhadG
_Miércoles 24 de agosto de 2016 a las 06:49 GMT_
_Abierto originalmente como https://github.com/storybooks/react-storybook-addon-info/issues/59_


Actualmente estoy exportando el componente junto con una versión empaquetada ( default export) para poder documentar el componente de forma aislada, ya que el default que está empaquetado con varias otras funciones de orden superior no No proporciono una referencia al propTypes para que reaccione-storybook.

Por ejemplo:

export class SampleComponent extends Component {

}

export default compose(...)(SampleComponent);

Estoy usando la importación { SampleComponent } para fines de documentación, sin embargo, obtengo dos UI renderizadas para propTables .

"SampleComponent" Component
property    propType    required    default
contextStyles   object  no  {{}}
height  number  no  -
image   string  yes -

"SampleComponent" ComponentNo propTypes defined!

Aunque estoy especificando las opciones para propTables con { propTables: [SampleComponent], inline: true } , obtengo ambas versiones renderizadas. ¿Alguna forma de deshabilitar el propTable automático para el componente que se representa? Parece que eso es lo que está sucediendo: los propTypes del componente renderizado también se están utilizando, de ahí el undefined ya que se exporta después de varios ajustes de función de orden superior.

Quizás, hay una mejor manera de lograr lo que necesito por completo ...

Gracias por su sugerencia.

info bug has workaround

Comentario más útil

Comentario de carlosrberto
_Jueves 26 de enero de 2017 a las 17:08 GMT_


Creo que propTables debería reemplazar las propTables predeterminadas

Todos 3 comentarios

Comentario de carlosrberto
_Jueves 26 de enero de 2017 a las 17:08 GMT_


Creo que propTables debería reemplazar las propTables predeterminadas

Comentario de FarhadG
_Lunes 30 de enero de 2017 a las 17:41 GMT_


Un enfoque que he encontrado que es bastante útil es simplemente exportar el componente "empaquetado" y "sin empaquetar" para que no solo pueda usarlos para probar fácilmente el componente empaquetado (y sus mejoras de orden superior) sino también el componente básico, pero también la capacidad de documentar el componente con Storybook con bastante facilidad.

Esto resuelve el problema de la doble representación, ya que uso el componente sin empaquetar para esa parte de la documentación y se puede usar para aprovechar otras funcionalidades de Storybook.

Espero que esto sea útil para otras personas que se encuentran con el mismo problema.

Comenté sobre el problema original desactualizado , y ahora que se ha cerrado, encontré este problema abierto, así que copiaré mi comentario en caso de que sea útil para alguien más: en los casos en que un contenedor es inevitable (por ejemplo, una historia para un componente interno de SVG que requiere un contenedor <svg> nivel superior), puede especificar una opción propTablesExclude para incluir en la lista negra (todos) los componentes que no desea que se muestren las tablas de accesorios por.

¿Fue útil esta página
0 / 5 - 0 calificaciones