https://github.com/jonspalmer/view_component-storybook

ViewComponent previews and testing in Storybook
https://github.com/jonspalmer/view_component-storybook

Last synced: 4 days ago
JSON representation

ViewComponent previews and testing in Storybook

• Host: GitHub
• URL: https://github.com/jonspalmer/view_component-storybook
• Owner: jonspalmer
• License: mit
• Created: 2020-04-12T19:07:57.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T11:31:30.000Z (11 months ago)
• Last Synced: 2025-02-09T07:05:26.837Z (12 days ago)
• Language: Ruby
• Homepage:
• Size: 617 KB
• Stars: 273
• Watchers: 3
• Forks: 39
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# ViewComponent::Storybook

The ViewComponent::Storybook gem provides Ruby api for writing stories describing [View Components](https://github.com/github/view_component) and allowing them to be previewed and tested in [Storybook](https://github.com/storybookjs/storybook/) via its [Server](https://github.com/storybookjs/storybook/tree/next/app/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](https://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](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./docs/CONTRIBUTING.md) as well.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).