Skip to content
This repository has been archived by the owner on Mar 22, 2023. It is now read-only.

unindented/storybook-addon-rtl

Repository files navigation

Storybook Addon RTL Version Build Status

Storybook Addon RTL allows you to switch to right-to-left flow in your stories in Storybook.

This addon has been tested with Storybook for React, Vue and Angular. It should also work in other frameworks.

Storybook Addon RTL Demo

Getting Started

npm i --save-dev storybook-addon-rtl

Add the addon to the addons array in .storybook/main.js

module.exports = {
  /// other storybook configuration
  addons: [
    // other addons here
    "storybook-addon-rtl",
  ],
};

Add the following to preview.js:

import { initializeRTL } from 'storybook-addon-rtl';

initializeRTL();

Then write your stories normally:

import React from 'react'
import MyComponent from './MyComponent'

export default {
  title: 'My Component',
  component: MyComponent
}
const Template = (args) => <MyComponent {...args}/>
export const default = Template.bind({})

// Optionally include direction as story parameter
rtlParameter.parameters = {
  direction: 'rtl'
}

Meta

Contributors

License

Copyright (c) 2017 Daniel Perez Alvarez (unindented.org). This is free software, and may be redistributed under the terms specified in the LICENSE file.