Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: Storybook args table documentation missing Description, Default, and complex controls #25769

Open
greggbursey opened this issue Jan 26, 2024 · 1 comment

Comments

@greggbursey
Copy link

greggbursey commented Jan 26, 2024

Describe the bug

Overview

Using Storybook to showcase components made with StencilJS, I can showcase that any component's table to display arguments are missing the following fields:

  • Description
  • Default

Additionally, complex controls that are controlled by a typescript type (for example) display as a simple text field as opposed to a select dropdown with fields to choose from based on the type.

Basic example

A stencil component's props are marked with JSDoc documentation:
/** This is label documentation. */
@Prop() label!: TestComponentProps['label'];

The docs table in storybook does not show any information for Description or Defaults:
image

Additionally, controls that should display in a pre-defined select dropdown based on a Typescript type, only shows a simple text box (as opposed to React where this select dropdown appears without issue):
image

To Reproduce

Reproduction repository

A reproduction repository can be found HERE.

System

Storybook Environment Info:

  System:
    OS: Windows 11 10.0.22621
    CPU: (20) x64 12th Gen Intel(R) Core(TM) i9-12900H
  Binaries:
    Node: 20.5.0 - C:\Program Files\nodejs\node.EXE
    npm: 9.8.0 - C:\Program Files\nodejs\npm.CMD <----- active
  Browsers:
    Edge: Chromium (120.0.2210.144)
  npmPackages:
    @storybook/addon-essentials: ^7.6.7 => 7.6.8
    @storybook/addon-links: ^7.6.7 => 7.6.8
    @storybook/addon-mdx-gfm: ^7.6.7 => 7.6.8
    @storybook/blocks: ^7.6.7 => 7.6.8
    @storybook/web-components: ^7.6.7 => 7.6.8
    @storybook/web-components-vite: ^7.6.7 => 7.6.8
    storybook: ^7.6.7 => 7.6.8

Additional context

No response

@siosio34
Copy link

me too

@vanessayuenn vanessayuenn self-assigned this Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Empathy Backlog
Development

No branches or pull requests

4 participants