Skip to main content

Crate use_storybook

Crate use_storybook 

Source
Expand description

§use-storybook

Storybook primitive metadata for component documentation, examples, stories, controls, and visual testing structure.

§Experimental

use-storybook is experimental while use-js remains below 0.3.0.

§Example

use use_storybook::{StorybookArgName, StorybookControlKind, StorybookStoryName};

let story = StorybookStoryName::new("Primary")?;
let arg = StorybookArgName::new("button.label")?;

assert_eq!(story.as_str(), "Primary");
assert_eq!(arg.as_str(), "button.label");
assert_eq!(StorybookControlKind::Select.as_str(), "select");

§Scope

  • Storybook version-family, framework, file-kind, story-kind, addon, config-file, control, and parameter labels.
  • Lightweight story name, component title, and argument name validation.

§Non-goals

  • Storybook runtime behavior.
  • Browser rendering or test runner behavior.
  • Story parsing, MDX parsing, or framework integrations.
  • Shelling out to storybook, node, or package-manager tooling.

§License

Licensed under either Apache-2.0 or MIT.

Structs§

StorybookArgName
Validated Storybook arg name metadata.
StorybookComponentTitle
Validated Storybook component title metadata.
StorybookStoryName
Validated Storybook story name metadata.

Enums§

StorybookAddonKind
Storybook addon labels.
StorybookConfigFile
Common Storybook config file labels.
StorybookControlKind
Storybook control-kind labels.
StorybookFileKind
Storybook file-kind labels.
StorybookFrameworkKind
Storybook framework labels.
StorybookNameError
Error returned when Storybook metadata is invalid.
StorybookParameterKind
Storybook parameter-kind labels.
StorybookStoryKind
Storybook story-kind labels.
StorybookVersionFamily
Storybook version-family labels.