How do I get TypeScript types for properties inside the parameters object?

[DarkstarXDD]

Summary

Hey, so I wanted to add a small description a story. I found out from the docs that I need to target the parameters.docs.description.story property to do so. https://storybook.js.org/docs/api/doc-blocks/doc-block-description

While it works, I didn't get any TypeScript auto complete for it.

When I searched it up a bit I found couple of discussions regarding this:
#22860
#19833

But it's still not clear to me what steps I need to follow in order to get it working. Is this documented somewhere in the docs? I couldn't find anything on the docs, but there's a good chance I may have missed it.

I doubt an important feature like this would be just limited to a PR note, so I am not sure whether that solution given in the PR is latest solution or is there anything new regarding this topic.

Additional information

No response

Create a reproduction

No response

[dosubot[bot]]

There’s no official Storybook documentation for enabling TypeScript autocomplete for properties like parameters.docs.description.story—the docs only show how to use the property, not how to type it in your codebase source. The recommended workaround is to use TypeScript module augmentation to extend the Parameters interface in your project. This approach is confirmed by maintainers and discussed in issue #22860 and PR #19833.

How to enable autocomplete for parameters.docs.description.story:

1. Create a .d.ts file (for example, storybook-parameters.d.ts) in your project (anywhere TypeScript will pick it up).
2. Add the following code to augment the Parameters interface:

// storybook-parameters.d.ts
import type { DocsParameters } from '@storybook/addon-docs';

declare module '@storybook/types' {
  interface Parameters {
    docs?: DocsParameters;
  }
}

This will give you type safety and autocomplete for parameters.docs.description.story in your stories, as long as your editor and TypeScript config are set up to pick up declaration merging.

Limitations:

• This is a manual setup and not retroactive for all addons or custom parameters—you’ll need to repeat the pattern for other custom parameter namespaces.
• Built-in autocomplete for these properties is not yet available out of the box.

Alternative:
The recommended way to add story descriptions is with JSDoc comments above your story exports, which provides better developer experience and type safety, but if you need to use parameters, the above workaround is the best option for now source.

You can follow issue #22860 for updates on official support or documentation for this pattern.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}