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

Parameters is loosely typed in CSF configuration #111

Open
arbrsts opened this issue Nov 26, 2024 · 0 comments
Open

Parameters is loosely typed in CSF configuration #111

arbrsts opened this issue Nov 26, 2024 · 0 comments

Comments

@arbrsts
Copy link

arbrsts commented Nov 26, 2024

https://github.com/ComponentDriven/csf/blob/next/src/story.ts

export interface Parameters {
  [name: string]: any;
}

Hi, I was trying to add an parameters.docs.story.iFrameHeight option but noticed that parameters is loosely typed.

Something like below would be helpful to document all available options.

export interface Parameters {
  docs?: {
    story?: {
      iFrameHeight?: number;
      // other story params...
    };
    // other docs params...
  };
  // other top-level params...
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant