Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 3.94 KB

ROADMAP.md

File metadata and controls

93 lines (62 loc) · 3.94 KB

Roadmap

Table of contents

New features

Doing these will be backwards compatible.

Responsive + multi-device viewports preview.

If you're smart about it you can already view the preview on multiple devices and windows. It's an iframe after-all. But story selection and addon-settings are not synced. We want to make this much much simpler and a core feature of storybook.

Automatic story detection

Some tools are doing automatic file detection, jest for example. We think such a feature is highly needed. A lot of users are already hacking this themselves using webpack specific features.

Themeability and override core UI components

Storybook is often used inside product companies and agencies. We want to help them have a sense of quality and immersion. We're interested in full customizability of our UI, though addons and options.

Add a playground addon

Many other styleguide-type projects have what's called a playground, where developers can change the code rendering the component inside the app. Storybook has a very tight connection with your editor, and it has a knobs addon. But we still see value in an addon that will allow the workflow of a playground.

See multiple (or all) stories in 1 preview.

Storybook's philosophy is about describing small bits in a variety of states. However, some components are best understood when viewed in multiple varieties in 1 view. It's quite common to see users write a single story, with wrapper components and multiple instances of the component the story is about. We plan to add a second mode to storybook that will allow you to see all stories in 1 preview. That way you can write your stories how they are best, and preview them how you like.

Supporting other frameworks and libraries

We believe in the power of react, and think it's the right choice for a lot of projects. But it's up to you and your team to decide your stack. Unfortunately, if you choose anything not from the list of supported frameworks you can not use storybook.

We want you to be able to use storybook with the framework / library of your choice.

Polymer & Webcomponents

Storybook for Polymer is currently in development and will support custom elements and plain HTML.

Aurelia

We're reaching out to the Aurelia maintainers to cooperate on this.

Breaking changes

Addon API

Our addon api is limited and will eventually have to be improved to accommodate better more optimized and modern addons.

API for adding stories

Currently, it's getting hard to set up a story that has data/options for multiple addons. We want to support this but will likely mean we will have to change the add method's API.

Documentation

Better design

We have a new logo, so the next step is an overhaul of our documentation site.

Record videos and write blog posts on how to use, tweak & develop storybook

  • writing addons,
  • choosing the right addons.
  • how to start developing on our codebase.
  • how to use storybook itself and the CLI.