storybookjs/storybook

[Bug]: @values in prop jsdoc do not populate controls through vue-docgen-api

Open

#28 558 ouverte le 11 juil. 2024

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)TypeScript (89 909 stars) (10 058 forks)batch import
bugdocgenhelp wantedsev:S3vue3

Description

Describe the bug

I expect that providing @values or type to a prop should result in an enum/select style, as that's the functionality of vue-docgen-api, but I'm not seeing that behaviour.

Reproduction link

https://stackblitz.com/edit/github-hfdqmp?file=src%2Fstories%2FButton.stories.js,src%2Fstories%2FButton.vue&preset=node

Reproduction steps

  1. Go to link
  2. Observe jsdoc block in component
  3. look at props table in docs story. It is a string input, but should be a select or radio button with the valid options provided in the jsdoc comment: @values 'small', 'medium', 'large'

System

Based on storybook.new starter I linked in the repro, but also happening in v7 and 8.2.1. 
I also tested the `vue-cli` and `typescript` Vue 3 starters on stackblitz.

Additional context

Also note the vue-component-meta is not working in this way as expected either, as demonstrated here: https://stackblitz.com/edit/github-akbacb?file=src%2Fstories%2FButton.stories.ts,src%2Fstories%2FButton.vue,.storybook%2Fmain.ts&preset=node

Guide contributeur

Stack technique
typescriptvue
Domaine
frontenddocumentation
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic Vue knowledgeFamiliarity with Storybook addons
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55
Direction de recherche
Investigate how vue docgen api parses @values from JSDoc in Vue components and how Storybook's addon vue maps props to controls. Look at the source code in the 'addons/vue' directory, specifically the part that extracts prop metadata. Examine the reproduction URLs to understand the expected behavior (select/radio) vs actual (string input). Check if there are related issue comments or PRs that hint at the root cause.