Skip to content

Parameters is loosely typed in CSF configuration #111

Description

@arbrsts

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...
}

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions