GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 02:51:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Lars Rickert 2024-04-08 19:42:29 +02:00
parent 659175a3e8
commit e8415decc1
No known key found for this signature in database
2 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
code/frameworks/vue3-vite/src/types.ts
View File

@ -26,13 +26,11 @@ export type FrameworkOptions = {
| { | {
plugin: 'vue-component-meta'; plugin: 'vue-component-meta';
/** /**
* Tsconfig filename to use. Should be set if your main `tsconfig.json` only includes references to other tsconfig files * Tsconfig filename to use. Should be set if your main `tsconfig.json` includes references to other tsconfig files
* like `tsconfig.app.json` which `vue-component-meta` does currently not support. * like `tsconfig.app.json`.
* Otherwise docgen might not be generated correctly (e.g. import aliases are not resolved). * Otherwise docgen might not be generated correctly (e.g. import aliases are not resolved).
* *
* Make sure that the specified tsconfig file does not contain `references`. * For further information, see our [docs](https://storybook.js.org/docs/get-started/vue3-vite#limitations).
*
* For further information about `vue-component-meta` limitations, see our [docs](https://storybook.js.org/docs/get-started/vue3-vite#limitations).
* *
* @default "tsconfig.json" * @default "tsconfig.json"
*/ */

13
docs/get-started/vue3-vite.md
View File

@ -277,15 +277,8 @@ The definition above will generate the following controls:
### Limitations ### Limitations
`vue-component-meta` does currently not support `tsconfig.json` files that use `references` to other tsconfig files (see [this issue](https://github.com/vuejs/language-tools/issues/3896) for more information). As result, you might face missing component types/descriptions or unresolvable import aliases, for example: If your `tsconfig.json` file uses `references` to other config files like `tsconfig.app.json`, `tsconfig.node.json` etc., you should define the tsconfig file used for your main application code via the framework option shown below so `vue-component-meta` can use it properly.
Otherwise, you might face missing component types/descriptions or unresolvable import aliases like `@/some/import`.
```ts
// YourComponent.ts
import type { MyProps } from '@/types'; // ❌ Cannot be resolved
import type { MyProps } from '../types'; // ✅ Can be resolved
```
So if your project uses a `tsconfig.json` file that only includes references to e.g. `tsconfig.app.json`, `tsconfig.node.json` etc., you should set the following framework option to the tsconfig file used for your main application code:
```ts ```ts
// .storybook/main.ts // .storybook/main.ts
@ -306,6 +299,8 @@ const config: StorybookConfig = {
export default config; export default config;
``` ```
For further information, you can take a look at [this issue](https://github.com/vuejs/language-tools/issues/3896).
## Troubleshooting ## Troubleshooting
### Storybook doesn't work with my Vue 2 project ### Storybook doesn't work with my Vue 2 project