Skip to content

jonspalmer/view_component-storybook

Repository files navigation

ViewComponent::Storybook

The ViewComponent::Storybook gem provides Ruby api for writing stories describing View Components and allowing them to be previewed and tested in Storybook via its Server support.

Features

  • A Ruby DSL for writing Stories describing View Components
  • A Rails controller backend for Storybook Server compatible with Storybook Controls Addon parameters
  • Coming Soon: Rake tasks to watch View Components and Stories and trigger Storybook hot reloading

Documentation

See jonspalmer.github.io/view_component-storybook for documentation.

Contributing

This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the Contributor Covenant code of conduct. We recommend reading the contributing guide as well.

License

The gem is available as open source under the terms of the MIT License.