INSTANT documentation with Storybook 7 AUTODOCS | Quick Tips

[@mytestaccount23]

Thank you! Short and concise but very helpful.

[@dweebycat9929]

Thank you! This was quick and helpful!

[@chromaticui]

Glad it helped! Hit me up if you have any topics you'd like to see covered - chan

[@ItIsMohammadreza]

How can I automatically generate props and types documentation in Storybook without the story object, but still make the component appear in the sidebar?

[@sebastienbacs]

Hello! Very helpfull tutorial, thank you! How can I set documentation like these on defined slots & emits in my Vue 3 project?

[@chromaticui]

my understanding is that Vue 3 slots are not globally supported in this way yet

[@SanderCokart]

is there a way for the autodocs to watch for changes made in components? Now in order to see what happend I have to restart storybook when using comments

[@chromaticui]

seems strange that you would have to fully restart. could you say more on the specific versions your using?

[@chromaticui]

additionally, the Storybook Discord is the best place to get help with Storybook discord.com/invite/storybook

[@SanderCokart]

7.3.2 react-vite framework@@chromaticui

[@SanderCokart]

I am already in it@@chromaticui

[@SakethTadimeti]

Does this work with react native ? i've tried adding the autodocs tag; but it never shows up.

[@abdoachhoubi588]

Would this work for a react-native (expo) app??

[@nuvotion-live]

Is there any way to leverage this feature for non-ui code like hooks and util functions included with my component library package? I would love to use jsdocs to auto generate them and not have to manually write them

[@chromaticui]

not that i'm aware of. but there are others in discord that may have run experiments - chan

[@jeremytenjo]

❤

[@BraianMellor]

can you explain the same (autodocs) but with Material UI types? it's not populating into the table

[@chromaticui]

hi braian! could you share what you're attempting to do in a storybook.new sandbox?

[@SanderCokart]

This also only works I believe with 1 component per file so component composition like Shadcn or Radix is not supported. It can only infer a single interface, typically top level only

[@chromaticui]

story files don't have to be written one-to-one with components. many teams create a number of story files to document named exports on multi-component modules. chan

[@SanderCokart]

@@chromaticui im saying if you have an Accordion, Accordion Item and Accordion Trigger in 1 file, autodocs will only infer the types and js doc blocks of the first component, in this case Accordion, Item and trigger are ignored despite them having their own props interfaces.

[@MaminaZvezdochka]

Is there any chance to merge autodocs file with MDX documentation?

[@chromaticui]

not sure i fully understand the request. is it possible that Docs Pages fit the bill you're looking for? it's a way to customize the autodocs template using Storybook Doc Blocks. kzbin.info/www/bejne/p2m2imevrrN4bLM - chan

[@AbdulAlim-zg8vt]

Autodocs is not working with web-components.

[@BaraiEnt]

❤