├── register.js ├── .babelrc ├── docs └── theme-picker.gif ├── .gitignore ├── src ├── index.js ├── register.js ├── WrapStory.js └── Panel.js ├── package.json ├── readme.md └── license.md /register.js: -------------------------------------------------------------------------------- 1 | require('./dist/register'); 2 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | "react", 4 | ["env", { "targets": { "node": "8.0.0" } }] 5 | ], 6 | } 7 | -------------------------------------------------------------------------------- /docs/theme-picker.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ticketmaster/storybook-styled-components/HEAD/docs/theme-picker.gif -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # IDE cruft 2 | .idea 3 | .DS_Store 4 | 5 | # npm bundles 6 | node_modules 7 | npm-debug.* 8 | coverage 9 | dist 10 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import addons from '@storybook/addons' 3 | import WrapStory from './WrapStory' 4 | 5 | export const withThemes = themes => (storyFn, context) => { 6 | const channel = addons.getChannel(); 7 | return ( 8 | {storyFn(context)} 12 | 13 | ) 14 | } 15 | -------------------------------------------------------------------------------- /src/register.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import addons from '@storybook/addons' 3 | import Panel from './Panel' 4 | 5 | addons.register('storybook-styled-components', api => { 6 | const channel = addons.getChannel(); 7 | 8 | addons.addPanel('storybook-styled-components/panel', { 9 | title: 'Theme Picker', 10 | render: (panelState) => , 11 | }) 12 | }) 13 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "storybook-styled-components", 3 | "version": "1.1.5", 4 | "description": "", 5 | "main": "dist/index.js", 6 | "jsnext:main": "src/index.js", 7 | "scripts": { 8 | "test": "echo \"Error: no test specified\" && exit 1", 9 | "build": "babel src --out-dir dist/", 10 | "prepublish": "npm run build" 11 | }, 12 | "author": "Nicolo Taddei ", 13 | "license": "ISC", 14 | "devDependencies": { 15 | "babel-cli": "^6.26.0", 16 | "babel-core": "^6.26.3", 17 | "babel-preset-env": "^1.7.0", 18 | "babel-preset-react": "^6.24.1" 19 | }, 20 | "peerDependencies": { 21 | "@storybook/addons": "^3.3.0", 22 | "react": "*", 23 | "react-dom": "*", 24 | "styled-components": "*" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # storybook-styled-components 2 | 3 | **DEPRECATED!** 4 | 5 | This plugin has issues when used with Storybook v5 and beyond, and there's a better option available at: 6 | https://github.com/echoulen/storybook-addon-styled-component-theme 7 | 8 | ![Theme Picker Animation](./docs/theme-picker.gif) 9 | 10 | _Switch between themes and see how your components react_ 11 | 12 | ## Set It Up 13 | 14 | inside your storybook addons, register the `storybook-styled-components`: 15 | 16 | ```javascript 17 | // addons.js 18 | import "storybook-styled-components/register"; 19 | ``` 20 | 21 | In your config.js, define your theme configuration and pass it in to the `addDecorator` function 22 | 23 | ```javascript 24 | // config.js 25 | import { configure, addDecorator } from "@storybook/react"; 26 | import { withThemes } from "storybook-styled-components"; 27 | 28 | // then import your themes 29 | import firstTheme from "./src/themes/first"; 30 | import secondTheme from "./src/themes/second"; 31 | 32 | const themes = { 33 | "First Theme": firstTheme, 34 | "Second Theme": secondTheme 35 | }; 36 | 37 | // now add the decorator 38 | addDecorator(withThemes(themes)); 39 | // done! 40 | ``` 41 | 42 | **This is still a Work In Progress ... Feedback welcomed** 43 | 44 | [Read The License](./license.md) 45 | -------------------------------------------------------------------------------- /src/WrapStory.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { ThemeProvider } from 'styled-components' 3 | import { getQueryParam } from '@storybook/client-api'; 4 | 5 | const currentThemeValueFromUrl = getQueryParam('currentTheme'); 6 | 7 | export default class WrapStory extends React.Component { 8 | 9 | constructor(props) { 10 | super(props) 11 | const keys = Object.keys(props.themes) 12 | this.state = {theme: props.themes[currentThemeValueFromUrl || keys[0]]} 13 | this.updateState = this.updateState.bind(this) 14 | } 15 | 16 | componentDidMount() { 17 | this.props.channel.emit('storybook-styled-components:init', this.props.themes) 18 | this.props.channel.on('storybook-styled-components:update', this.updateState) 19 | } 20 | 21 | componentWillUnmount() { 22 | this.props.channel.removeListener('storybook-styled-components:init', this.props.themes) 23 | this.props.channel.removeListener('storybook-styled-components:update', this.updateState) 24 | } 25 | 26 | componentWillReceiveProps(props) { 27 | this.setState(props) 28 | } 29 | 30 | updateState(theme) { 31 | const {themes} = this.props 32 | this.setState({theme: themes[theme]}) 33 | } 34 | 35 | render() { 36 | const {children} = this.props 37 | const {theme} = this.state 38 | return theme ? {children} : children 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/Panel.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | 3 | export default class Panel extends React.Component { 4 | 5 | constructor(props) { 6 | super(props); 7 | 8 | this.state = { 9 | theme: null, 10 | themes: {}, 11 | initialised: false, 12 | }; 13 | 14 | this.onInit = this.onInit.bind(this) 15 | this.updateTheme = this.updateTheme.bind(this) 16 | 17 | this.props.channel.on('storybook-styled-components:init', this.onInit); 18 | } 19 | 20 | componentWillUnmount() { 21 | this.props.channel.removeListener('storybook-styled-components:init', this.onInit); 22 | } 23 | 24 | onInit(themes) { 25 | const queryTheme = this.props.api.getQueryParam('currentTheme') 26 | 27 | const theme = queryTheme 28 | ? queryTheme 29 | : this.state.theme ? this.state.theme : Object.keys(themes)[0] 30 | 31 | this.setTheme(themes, theme) 32 | } 33 | 34 | updateTheme(e) { 35 | this.setTheme(this.state.themes, e.target.value) 36 | } 37 | 38 | setTheme(themes, theme) { 39 | this.setState({ themes, theme }) 40 | this.props.channel.emit('storybook-styled-components:update', theme) 41 | this.props.api.setQueryParams({ currentTheme: theme }) 42 | } 43 | 44 | render() { 45 | if(!this.props.active) return (null); 46 | 47 | const { theme, themes } = this.state 48 | 49 | if (!theme) return
Addon is initialising
50 | 51 | return ( 52 |
53 | 58 |
59 | ) 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /license.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | Copyright 2017 Ticketmaster --------------------------------------------------------------------------------