@storybook/addon-backgrounds 7.0.0-alpha.8 → 7.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +1 -1
  2. package/dist/chunk-HZTLTKXL.mjs +5 -0
  3. package/dist/index.d.ts +3 -0
  4. package/dist/index.js +1 -0
  5. package/dist/index.mjs +1 -0
  6. package/dist/manager.d.ts +1 -0
  7. package/dist/manager.js +5 -0
  8. package/dist/manager.mjs +1 -0
  9. package/dist/preview.d.ts +21 -0
  10. package/dist/preview.js +20 -0
  11. package/dist/preview.mjs +16 -0
  12. package/jest.config.js +7 -0
  13. package/manager.js +1 -1
  14. package/package.json +61 -16
  15. package/preview.js +1 -1
  16. package/LICENSE +0 -21
  17. package/dist/cjs/components/ColorIcon.js +0 -24
  18. package/dist/cjs/constants.js +0 -16
  19. package/dist/cjs/containers/BackgroundSelector.js +0 -113
  20. package/dist/cjs/containers/GridSelector.js +0 -48
  21. package/dist/cjs/decorators/withBackground.js +0 -52
  22. package/dist/cjs/decorators/withGrid.js +0 -82
  23. package/dist/cjs/helpers/index.js +0 -113
  24. package/dist/cjs/index.js +0 -14
  25. package/dist/cjs/manager.js +0 -26
  26. package/dist/cjs/preview.js +0 -30
  27. package/dist/cjs/types/index.js +0 -5
  28. package/dist/esm/components/ColorIcon.js +0 -14
  29. package/dist/esm/constants.js +0 -6
  30. package/dist/esm/containers/BackgroundSelector.js +0 -91
  31. package/dist/esm/containers/GridSelector.js +0 -32
  32. package/dist/esm/decorators/withBackground.js +0 -40
  33. package/dist/esm/decorators/withGrid.js +0 -65
  34. package/dist/esm/helpers/index.js +0 -86
  35. package/dist/esm/index.js +0 -6
  36. package/dist/esm/manager.js +0 -15
  37. package/dist/esm/preview.js +0 -19
  38. package/dist/esm/types/index.js +0 -1
  39. package/dist/types/components/ColorIcon.d.ts +0 -3
  40. package/dist/types/constants.d.ts +0 -6
  41. package/dist/types/containers/BackgroundSelector.d.ts +0 -2
  42. package/dist/types/containers/GridSelector.d.ts +0 -2
  43. package/dist/types/decorators/withBackground.d.ts +0 -2
  44. package/dist/types/decorators/withGrid.d.ts +0 -2
  45. package/dist/types/helpers/index.d.ts +0 -6
  46. package/dist/types/index.d.ts +0 -2
  47. package/dist/types/manager.d.ts +0 -1
  48. package/dist/types/preview.d.ts +0 -14
  49. package/dist/types/types/index.d.ts +0 -28
  50. package/register.js +0 -6
package/README.md CHANGED
@@ -4,7 +4,7 @@ Storybook Addon Backgrounds can be used to change background colors inside the p
4
4
 
5
5
  [Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)
6
6
 
7
- ![React Storybook Screenshot](https://raw.githubusercontent.com/storybookjs/storybook/next/addons/backgrounds/docs/addon-backgrounds.gif)
7
+ ![React Storybook Screenshot](https://raw.githubusercontent.com/storybookjs/storybook/next/code/addons/backgrounds/docs/addon-backgrounds.gif)
8
8
 
9
9
  ## Installation
10
10
 
@@ -0,0 +1,5 @@
1
+ var ADDON_ID="storybook/background",PARAM_KEY="backgrounds";var EVENTS={UPDATE:`${ADDON_ID}/update`};import global from"global";import{dedent}from"ts-dedent";import{logger}from"@storybook/client-logger";var{document,window}=global,isReduceMotionEnabled=()=>window.matchMedia("(prefers-reduced-motion: reduce)").matches,getBackgroundColorByName=(currentSelectedValue,backgrounds=[],defaultName)=>{if(currentSelectedValue==="transparent")return"transparent";if(backgrounds.find(background=>background.value===currentSelectedValue))return currentSelectedValue;let defaultBackground=backgrounds.find(background=>background.name===defaultName);if(defaultBackground)return defaultBackground.value;if(defaultName){let availableColors=backgrounds.map(background=>background.name).join(", ");logger.warn(dedent`
2
+ Backgrounds Addon: could not find the default color "${defaultName}".
3
+ These are the available colors for your story based on your configuration:
4
+ ${availableColors}.
5
+ `)}return"transparent"},clearStyles=selector=>{(Array.isArray(selector)?selector:[selector]).forEach(clearStyle)},clearStyle=selector=>{let element=document.getElementById(selector);element&&element.parentElement.removeChild(element)},addGridStyle=(selector,css)=>{let existingStyle=document.getElementById(selector);if(existingStyle)existingStyle.innerHTML!==css&&(existingStyle.innerHTML=css);else{let style=document.createElement("style");style.setAttribute("id",selector),style.innerHTML=css,document.head.appendChild(style)}},addBackgroundStyle=(selector,css,storyId)=>{let existingStyle=document.getElementById(selector);if(existingStyle)existingStyle.innerHTML!==css&&(existingStyle.innerHTML=css);else{let style=document.createElement("style");style.setAttribute("id",selector),style.innerHTML=css;let gridStyleSelector=`addon-backgrounds-grid${storyId?`-docs-${storyId}`:""}`,existingGridStyle=document.getElementById(gridStyleSelector);existingGridStyle?existingGridStyle.parentElement.insertBefore(style,existingGridStyle):document.head.appendChild(style)}};export{ADDON_ID,PARAM_KEY,isReduceMotionEnabled,getBackgroundColorByName,clearStyles,addGridStyle,addBackgroundStyle};
@@ -0,0 +1,3 @@
1
+ declare const _default: {};
2
+
3
+ export { _default as default };
package/dist/index.js ADDED
@@ -0,0 +1 @@
1
+ var t=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var i=Object.prototype.hasOwnProperty;var c=(o,e)=>{for(var l in e)t(o,l,{get:e[l],enumerable:!0})},f=(o,e,l,u)=>{if(e&&typeof e=="object"||typeof e=="function")for(let d of h(e))!i.call(o,d)&&d!==l&&t(o,d,{get:()=>e[d],enumerable:!(u=m(e,d))||u.enumerable});return o};var n=o=>f(t({},"__esModule",{value:!0}),o);var p={};c(p,{default:()=>a});module.exports=n(p);module&&module.hot&&module.hot.decline&&module.hot.decline();var a={};0&&(module.exports={});
package/dist/index.mjs ADDED
@@ -0,0 +1 @@
1
+ module&&module.hot&&module.hot.decline&&module.hot.decline();var src_default={};export{src_default as default};
@@ -0,0 +1 @@
1
+
@@ -0,0 +1,5 @@
1
+ var _=Object.create;var A=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var H=Object.getOwnPropertyNames;var F=Object.getPrototypeOf,O=Object.prototype.hasOwnProperty;var K=(r,t,e,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of H(t))!O.call(r,o)&&o!==e&&A(r,o,{get:()=>t[o],enumerable:!(n=v(t,o))||n.enumerable});return r};var c=(r,t,e)=>(e=r!=null?_(F(r)):{},K(t||!r||!r.__esModule?A(e,"default",{value:r,enumerable:!0}):e,r));var d=c(require("react")),g=require("@storybook/manager-api");var p="storybook/background",a="backgrounds";var $={UPDATE:`${p}/update`};var i=c(require("react")),b=c(require("memoizerific")),u=require("@storybook/manager-api"),G=require("@storybook/client-logger"),l=require("@storybook/components");var C=require("@storybook/theming"),E=C.styled.span(({background:r})=>({borderRadius:"1rem",display:"block",height:"1rem",width:"1rem",background:r}),({theme:r})=>({boxShadow:`${r.appBorderColor} 0 0 0 1px inset`}));var S=c(require("global")),M=require("ts-dedent"),I=require("@storybook/client-logger"),{document:j,window:W}=S.default;var T=(r,t=[],e)=>{if(r==="transparent")return"transparent";if(t.find(o=>o.value===r))return r;let n=t.find(o=>o.name===e);if(n)return n.value;if(e){let o=t.map(s=>s.name).join(", ");I.logger.warn(M.dedent`
2
+ Backgrounds Addon: could not find the default color "${e}".
3
+ These are the available colors for your story based on your configuration:
4
+ ${o}.
5
+ `)}return"transparent"};var x=(0,b.default)(1e3)((r,t,e,n,o,s)=>({id:r||t,title:t,onClick:()=>{o({selected:e,name:t})},value:e,right:n?i.default.createElement(E,{background:e}):void 0,active:s})),N=(0,b.default)(10)((r,t,e)=>{let n=r.map(({name:o,value:s})=>x(null,o,s,!0,e,s===t));return t!=="transparent"?[x("reset","Clear background","transparent",null,e,!1),...n]:n}),w={default:null,disable:!0,values:[]},L=(0,i.memo)(function(){var B;let t=(0,u.useParameter)(a,w),[e,n]=(0,u.useGlobals)(),o=(B=e[a])==null?void 0:B.value,s=(0,i.useMemo)(()=>T(o,t.values,t.default),[t,o]);Array.isArray(t)&&G.logger.warn("Addon Backgrounds api has changed in Storybook 6.0. Please refer to the migration guide: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md");let P=(0,i.useCallback)(y=>{n({[a]:{...e[a],value:y}})},[t,e,n]);return t.disable?null:i.default.createElement(i.Fragment,null,i.default.createElement(l.WithTooltip,{placement:"top",trigger:"click",closeOnClick:!0,tooltip:({onHide:y})=>i.default.createElement(l.TooltipLinkList,{links:N(t.values,s,({selected:h})=>{s!==h&&P(h),y()})})},i.default.createElement(l.IconButton,{key:"background",title:"Change the background of the preview",active:s!=="transparent"},i.default.createElement(l.Icons,{icon:"photo"}))))});var m=c(require("react")),f=require("@storybook/manager-api"),k=require("@storybook/components");var D=(0,m.memo)(function(){var s;let[t,e]=(0,f.useGlobals)(),{grid:n}=(0,f.useParameter)(a,{grid:{disable:!1}});if(n!=null&&n.disable)return null;let o=((s=t[a])==null?void 0:s.grid)||!1;return m.default.createElement(k.IconButton,{key:"background",active:o,title:"Apply a grid to the preview",onClick:()=>e({[a]:{...t[a],grid:!o}})},m.default.createElement(k.Icons,{icon:"grid"}))});g.addons.register(p,()=>{g.addons.add(p,{title:"Backgrounds",type:g.types.TOOL,match:({viewMode:r})=>!!(r&&r.match(/^(story|docs)$/)),render:()=>d.default.createElement(d.Fragment,null,d.default.createElement(L,null),d.default.createElement(D,null))})});
@@ -0,0 +1 @@
1
+ import{ADDON_ID,PARAM_KEY,getBackgroundColorByName}from"./chunk-HZTLTKXL.mjs";import React3,{Fragment as Fragment2}from"react";import{addons,types}from"@storybook/manager-api";import React,{Fragment,useCallback,useMemo,memo}from"react";import memoize from"memoizerific";import{useParameter,useGlobals}from"@storybook/manager-api";import{logger}from"@storybook/client-logger";import{Icons,IconButton,WithTooltip,TooltipLinkList}from"@storybook/components";import{styled}from"@storybook/theming";var ColorIcon=styled.span(({background})=>({borderRadius:"1rem",display:"block",height:"1rem",width:"1rem",background}),({theme})=>({boxShadow:`${theme.appBorderColor} 0 0 0 1px inset`}));var createBackgroundSelectorItem=memoize(1e3)((id,name,value,hasSwatch,change,active)=>({id:id||name,title:name,onClick:()=>{change({selected:value,name})},value,right:hasSwatch?React.createElement(ColorIcon,{background:value}):void 0,active})),getDisplayedItems=memoize(10)((backgrounds,selectedBackgroundColor,change)=>{let backgroundSelectorItems=backgrounds.map(({name,value})=>createBackgroundSelectorItem(null,name,value,!0,change,value===selectedBackgroundColor));return selectedBackgroundColor!=="transparent"?[createBackgroundSelectorItem("reset","Clear background","transparent",null,change,!1),...backgroundSelectorItems]:backgroundSelectorItems}),DEFAULT_BACKGROUNDS_CONFIG={default:null,disable:!0,values:[]},BackgroundSelector=memo(function(){let backgroundsConfig=useParameter(PARAM_KEY,DEFAULT_BACKGROUNDS_CONFIG),[globals,updateGlobals]=useGlobals(),globalsBackgroundColor=globals[PARAM_KEY]?.value,selectedBackgroundColor=useMemo(()=>getBackgroundColorByName(globalsBackgroundColor,backgroundsConfig.values,backgroundsConfig.default),[backgroundsConfig,globalsBackgroundColor]);Array.isArray(backgroundsConfig)&&logger.warn("Addon Backgrounds api has changed in Storybook 6.0. Please refer to the migration guide: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md");let onBackgroundChange=useCallback(value=>{updateGlobals({[PARAM_KEY]:{...globals[PARAM_KEY],value}})},[backgroundsConfig,globals,updateGlobals]);return backgroundsConfig.disable?null:React.createElement(Fragment,null,React.createElement(WithTooltip,{placement:"top",trigger:"click",closeOnClick:!0,tooltip:({onHide})=>React.createElement(TooltipLinkList,{links:getDisplayedItems(backgroundsConfig.values,selectedBackgroundColor,({selected})=>{selectedBackgroundColor!==selected&&onBackgroundChange(selected),onHide()})})},React.createElement(IconButton,{key:"background",title:"Change the background of the preview",active:selectedBackgroundColor!=="transparent"},React.createElement(Icons,{icon:"photo"}))))});import React2,{memo as memo2}from"react";import{useGlobals as useGlobals2,useParameter as useParameter2}from"@storybook/manager-api";import{Icons as Icons2,IconButton as IconButton2}from"@storybook/components";var GridSelector=memo2(function(){let[globals,updateGlobals]=useGlobals2(),{grid}=useParameter2(PARAM_KEY,{grid:{disable:!1}});if(grid?.disable)return null;let isActive=globals[PARAM_KEY]?.grid||!1;return React2.createElement(IconButton2,{key:"background",active:isActive,title:"Apply a grid to the preview",onClick:()=>updateGlobals({[PARAM_KEY]:{...globals[PARAM_KEY],grid:!isActive}})},React2.createElement(Icons2,{icon:"grid"}))});addons.register(ADDON_ID,()=>{addons.add(ADDON_ID,{title:"Backgrounds",type:types.TOOL,match:({viewMode})=>!!(viewMode&&viewMode.match(/^(story|docs)$/)),render:()=>React3.createElement(Fragment2,null,React3.createElement(BackgroundSelector,null),React3.createElement(GridSelector,null))})});
@@ -0,0 +1,21 @@
1
+ import * as lib_types_dist from 'lib/types/dist';
2
+
3
+ declare const decorators: ((StoryFn: lib_types_dist.PartialStoryFn<lib_types_dist.Renderer, lib_types_dist.Args>, context: lib_types_dist.StoryContext<lib_types_dist.Renderer, lib_types_dist.Args>) => unknown)[];
4
+ declare const parameters: {
5
+ backgrounds: {
6
+ grid: {
7
+ cellSize: number;
8
+ opacity: number;
9
+ cellAmount: number;
10
+ };
11
+ values: {
12
+ name: string;
13
+ value: string;
14
+ }[];
15
+ };
16
+ };
17
+ declare const globals: {
18
+ backgrounds: any;
19
+ };
20
+
21
+ export { decorators, globals, parameters };
@@ -0,0 +1,20 @@
1
+ var H=Object.create;var b=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var K=Object.getPrototypeOf,Y=Object.prototype.hasOwnProperty;var D=(r,e)=>{for(var o in e)b(r,o,{get:e[o],enumerable:!0})},E=(r,e,o,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of F(e))!Y.call(r,t)&&t!==o&&b(r,t,{get:()=>e[t],enumerable:!(n=_(e,t))||n.enumerable});return r};var G=(r,e,o)=>(o=r!=null?H(K(r)):{},E(e||!r||!r.__esModule?b(o,"default",{value:r,enumerable:!0}):o,r)),I=r=>E(b({},"__esModule",{value:!0}),r);var q={};D(q,{decorators:()=>U,globals:()=>X,parameters:()=>j});module.exports=I(q);var g=require("@storybook/preview-api");var z="storybook/background",d="backgrounds";var Q={UPDATE:`${z}/update`};var A=G(require("global")),B=require("ts-dedent"),h=require("@storybook/client-logger"),{document:c,window:N}=A.default,R=()=>N.matchMedia("(prefers-reduced-motion: reduce)").matches,v=(r,e=[],o)=>{if(r==="transparent")return"transparent";if(e.find(t=>t.value===r))return r;let n=e.find(t=>t.name===o);if(n)return n.value;if(o){let t=e.map(i=>i.name).join(", ");h.logger.warn(B.dedent`
2
+ Backgrounds Addon: could not find the default color "${o}".
3
+ These are the available colors for your story based on your configuration:
4
+ ${t}.
5
+ `)}return"transparent"},$=r=>{(Array.isArray(r)?r:[r]).forEach(O)},O=r=>{let e=c.getElementById(r);e&&e.parentElement.removeChild(e)},w=(r,e)=>{let o=c.getElementById(r);if(o)o.innerHTML!==e&&(o.innerHTML=e);else{let n=c.createElement("style");n.setAttribute("id",r),n.innerHTML=e,c.head.appendChild(n)}},C=(r,e,o)=>{let n=c.getElementById(r);if(n)n.innerHTML!==e&&(n.innerHTML=e);else{let t=c.createElement("style");t.setAttribute("id",r),t.innerHTML=e;let i=`addon-backgrounds-grid${o?`-docs-${o}`:""}`,s=c.getElementById(i);s?s.parentElement.insertBefore(t,s):c.head.appendChild(t)}};var T=(r,e)=>{var M;let{globals:o,parameters:n}=e,t=(M=o[d])==null?void 0:M.value,i=n[d],s=(0,g.useMemo)(()=>i.disable?"transparent":v(t,i.values,i.default),[i,t]),a=(0,g.useMemo)(()=>s&&s!=="transparent",[s]),l=e.viewMode==="docs"?`#anchor--${e.id} .docs-story`:".sb-show-main",u=(0,g.useMemo)(()=>{let p="transition: background-color 0.3s;";return`
6
+ ${l} {
7
+ background: ${s} !important;
8
+ ${R()?"":p}
9
+ }
10
+ `},[s,l]);return(0,g.useEffect)(()=>{let p=e.viewMode==="docs"?`addon-backgrounds-docs-${e.id}`:"addon-backgrounds-color";if(!a){$(p);return}C(p,u,e.viewMode==="docs"?e.id:null)},[a,u,e]),r()};var x=require("@storybook/preview-api");var L=(r,e)=>{var S;let{globals:o,parameters:n}=e,t=n[d].grid,i=((S=o[d])==null?void 0:S.grid)===!0&&t.disable!==!0,{cellAmount:s,cellSize:a,opacity:l}=t,u=e.viewMode==="docs",p=n.layout===void 0||n.layout==="padded"?16:0,m=t.offsetX??(u?20:p),f=t.offsetY??(u?20:p),k=(0,x.useMemo)(()=>{let y=e.viewMode==="docs"?`#anchor--${e.id} .docs-story`:".sb-show-main",P=[`${a*s}px ${a*s}px`,`${a*s}px ${a*s}px`,`${a}px ${a}px`,`${a}px ${a}px`].join(", ");return`
11
+ ${y} {
12
+ background-size: ${P} !important;
13
+ background-position: ${m}px ${f}px, ${m}px ${f}px, ${m}px ${f}px, ${m}px ${f}px !important;
14
+ background-blend-mode: difference !important;
15
+ background-image: linear-gradient(rgba(130, 130, 130, ${l}) 1px, transparent 1px),
16
+ linear-gradient(90deg, rgba(130, 130, 130, ${l}) 1px, transparent 1px),
17
+ linear-gradient(rgba(130, 130, 130, ${l/2}) 1px, transparent 1px),
18
+ linear-gradient(90deg, rgba(130, 130, 130, ${l/2}) 1px, transparent 1px) !important;
19
+ }
20
+ `},[a]);return(0,x.useEffect)(()=>{let y=e.viewMode==="docs"?`addon-backgrounds-grid-docs-${e.id}`:"addon-backgrounds-grid";if(!i){$(y);return}w(y,k)},[i,k,e]),r()};var U=[L,T],j={[d]:{grid:{cellSize:20,opacity:.5,cellAmount:5},values:[{name:"light",value:"#F8F8F8"},{name:"dark",value:"#333333"}]}},X={[d]:null};0&&(module.exports={decorators,globals,parameters});
@@ -0,0 +1,16 @@
1
+ import{PARAM_KEY,addBackgroundStyle,addGridStyle,clearStyles,getBackgroundColorByName,isReduceMotionEnabled}from"./chunk-HZTLTKXL.mjs";import{useMemo,useEffect}from"@storybook/preview-api";var withBackground=(StoryFn,context)=>{let{globals:globals2,parameters:parameters2}=context,globalsBackgroundColor=globals2[PARAM_KEY]?.value,backgroundsConfig=parameters2[PARAM_KEY],selectedBackgroundColor=useMemo(()=>backgroundsConfig.disable?"transparent":getBackgroundColorByName(globalsBackgroundColor,backgroundsConfig.values,backgroundsConfig.default),[backgroundsConfig,globalsBackgroundColor]),isActive=useMemo(()=>selectedBackgroundColor&&selectedBackgroundColor!=="transparent",[selectedBackgroundColor]),selector=context.viewMode==="docs"?`#anchor--${context.id} .docs-story`:".sb-show-main",backgroundStyles=useMemo(()=>{let transitionStyle="transition: background-color 0.3s;";return`
2
+ ${selector} {
3
+ background: ${selectedBackgroundColor} !important;
4
+ ${isReduceMotionEnabled()?"":transitionStyle}
5
+ }
6
+ `},[selectedBackgroundColor,selector]);return useEffect(()=>{let selectorId=context.viewMode==="docs"?`addon-backgrounds-docs-${context.id}`:"addon-backgrounds-color";if(!isActive){clearStyles(selectorId);return}addBackgroundStyle(selectorId,backgroundStyles,context.viewMode==="docs"?context.id:null)},[isActive,backgroundStyles,context]),StoryFn()};import{useMemo as useMemo2,useEffect as useEffect2}from"@storybook/preview-api";var withGrid=(StoryFn,context)=>{let{globals:globals2,parameters:parameters2}=context,gridParameters=parameters2[PARAM_KEY].grid,isActive=globals2[PARAM_KEY]?.grid===!0&&gridParameters.disable!==!0,{cellAmount,cellSize,opacity}=gridParameters,isInDocs=context.viewMode==="docs",defaultOffset=parameters2.layout===void 0||parameters2.layout==="padded"?16:0,offsetX=gridParameters.offsetX??(isInDocs?20:defaultOffset),offsetY=gridParameters.offsetY??(isInDocs?20:defaultOffset),gridStyles=useMemo2(()=>{let selector=context.viewMode==="docs"?`#anchor--${context.id} .docs-story`:".sb-show-main",backgroundSize=[`${cellSize*cellAmount}px ${cellSize*cellAmount}px`,`${cellSize*cellAmount}px ${cellSize*cellAmount}px`,`${cellSize}px ${cellSize}px`,`${cellSize}px ${cellSize}px`].join(", ");return`
7
+ ${selector} {
8
+ background-size: ${backgroundSize} !important;
9
+ background-position: ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px !important;
10
+ background-blend-mode: difference !important;
11
+ background-image: linear-gradient(rgba(130, 130, 130, ${opacity}) 1px, transparent 1px),
12
+ linear-gradient(90deg, rgba(130, 130, 130, ${opacity}) 1px, transparent 1px),
13
+ linear-gradient(rgba(130, 130, 130, ${opacity/2}) 1px, transparent 1px),
14
+ linear-gradient(90deg, rgba(130, 130, 130, ${opacity/2}) 1px, transparent 1px) !important;
15
+ }
16
+ `},[cellSize]);return useEffect2(()=>{let selectorId=context.viewMode==="docs"?`addon-backgrounds-grid-docs-${context.id}`:"addon-backgrounds-grid";if(!isActive){clearStyles(selectorId);return}addGridStyle(selectorId,gridStyles)},[isActive,gridStyles,context]),StoryFn()};var decorators=[withGrid,withBackground],parameters={[PARAM_KEY]:{grid:{cellSize:20,opacity:.5,cellAmount:5},values:[{name:"light",value:"#F8F8F8"},{name:"dark",value:"#333333"}]}},globals={[PARAM_KEY]:null};export{decorators,globals,parameters};
package/jest.config.js ADDED
@@ -0,0 +1,7 @@
1
+ const path = require('path');
2
+ const baseConfig = require('../../jest.config.browser');
3
+
4
+ module.exports = {
5
+ ...baseConfig,
6
+ displayName: __dirname.split(path.sep).slice(-2).join(path.posix.sep),
7
+ };
package/manager.js CHANGED
@@ -1 +1 @@
1
- import './dist/esm/manager';
1
+ import './dist/manager';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/addon-backgrounds",
3
- "version": "7.0.0-alpha.8",
3
+ "version": "7.0.0-beta.1",
4
4
  "description": "Switch backgrounds to view components in different settings",
5
5
  "keywords": [
6
6
  "addon",
@@ -25,9 +25,45 @@
25
25
  },
26
26
  "license": "MIT",
27
27
  "author": "jbaxleyiii",
28
- "main": "dist/cjs/index.js",
29
- "module": "dist/esm/index.js",
30
- "types": "dist/types/index.d.ts",
28
+ "exports": {
29
+ ".": {
30
+ "require": "./dist/index.js",
31
+ "import": "./dist/index.mjs",
32
+ "types": "./dist/index.d.ts"
33
+ },
34
+ "./manager": {
35
+ "require": "./dist/manager.js",
36
+ "import": "./dist/manager.mjs",
37
+ "types": "./dist/manager.d.ts"
38
+ },
39
+ "./preview": {
40
+ "require": "./dist/preview.js",
41
+ "import": "./dist/preview.mjs",
42
+ "types": "./dist/preview.d.ts"
43
+ },
44
+ "./register": {
45
+ "require": "./dist/manager.js",
46
+ "import": "./dist/manager.mjs",
47
+ "types": "./dist/manager.d.ts"
48
+ },
49
+ "./package.json": "./package.json"
50
+ },
51
+ "main": "dist/index.js",
52
+ "module": "dist/index.mjs",
53
+ "types": "dist/index.d.ts",
54
+ "typesVersions": {
55
+ "*": {
56
+ "*": [
57
+ "dist/index.d.ts"
58
+ ],
59
+ "manager": [
60
+ "dist/manager.d.ts"
61
+ ],
62
+ "preview": [
63
+ "dist/preview.d.ts"
64
+ ]
65
+ }
66
+ },
31
67
  "files": [
32
68
  "dist/**/*",
33
69
  "README.md",
@@ -35,21 +71,23 @@
35
71
  "*.d.ts"
36
72
  ],
37
73
  "scripts": {
38
- "prepare": "node ../../scripts/prepare.js"
74
+ "check": "../../../scripts/node_modules/.bin/tsc --noEmit",
75
+ "prep": "../../../scripts/prepare/bundle.ts"
39
76
  },
40
77
  "dependencies": {
41
- "@storybook/addons": "7.0.0-alpha.8",
42
- "@storybook/api": "7.0.0-alpha.8",
43
- "@storybook/client-logger": "7.0.0-alpha.8",
44
- "@storybook/components": "7.0.0-alpha.8",
45
- "@storybook/core-events": "7.0.0-alpha.8",
46
- "@storybook/csf": "0.0.2--canary.4566f4d.1",
47
- "@storybook/theming": "7.0.0-alpha.8",
48
- "core-js": "^3.8.2",
78
+ "@storybook/client-logger": "7.0.0-beta.1",
79
+ "@storybook/components": "7.0.0-beta.1",
80
+ "@storybook/core-events": "7.0.0-beta.1",
81
+ "@storybook/manager-api": "7.0.0-beta.1",
82
+ "@storybook/preview-api": "7.0.0-beta.1",
83
+ "@storybook/theming": "7.0.0-beta.1",
84
+ "@storybook/types": "7.0.0-beta.1",
49
85
  "global": "^4.4.0",
50
86
  "memoizerific": "^1.11.3",
51
- "ts-dedent": "^2.0.0",
52
- "util-deprecate": "^1.0.2"
87
+ "ts-dedent": "^2.0.0"
88
+ },
89
+ "devDependencies": {
90
+ "typescript": "~4.9.3"
53
91
  },
54
92
  "peerDependencies": {
55
93
  "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
@@ -66,7 +104,14 @@
66
104
  "publishConfig": {
67
105
  "access": "public"
68
106
  },
69
- "gitHead": "24725501c32a073cebc6bf2674a47357136fbe3a",
107
+ "bundler": {
108
+ "entries": [
109
+ "./src/index.ts",
110
+ "./src/manager.tsx",
111
+ "./src/preview.tsx"
112
+ ]
113
+ },
114
+ "gitHead": "42c08678ac06d9c2c8e7a4c31a91e0a14bf5c2cd",
70
115
  "storybook": {
71
116
  "displayName": "Backgrounds",
72
117
  "icon": "https://user-images.githubusercontent.com/263385/101991667-479cc600-3c7c-11eb-96d3-410e936252e7.png",
package/preview.js CHANGED
@@ -1 +1 @@
1
- export * from './dist/esm/preview';
1
+ export * from './dist/preview';
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2017 Kadira Inc. <hello@kadira.io>
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
@@ -1,24 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.ColorIcon = void 0;
7
-
8
- var _theming = require("@storybook/theming");
9
-
10
- const ColorIcon = _theming.styled.span(({
11
- background
12
- }) => ({
13
- borderRadius: '1rem',
14
- display: 'block',
15
- height: '1rem',
16
- width: '1rem',
17
- background
18
- }), ({
19
- theme
20
- }) => ({
21
- boxShadow: `${theme.appBorderColor} 0 0 0 1px inset`
22
- }));
23
-
24
- exports.ColorIcon = ColorIcon;
@@ -1,16 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.PARAM_KEY = exports.GRID_PARAM_KEY = exports.EVENTS = exports.ADDON_ID = void 0;
7
- const ADDON_ID = 'storybook/background';
8
- exports.ADDON_ID = ADDON_ID;
9
- const PARAM_KEY = 'backgrounds';
10
- exports.PARAM_KEY = PARAM_KEY;
11
- const GRID_PARAM_KEY = 'grid';
12
- exports.GRID_PARAM_KEY = GRID_PARAM_KEY;
13
- const EVENTS = {
14
- UPDATE: `${ADDON_ID}/update`
15
- };
16
- exports.EVENTS = EVENTS;
@@ -1,113 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.BackgroundSelector = void 0;
7
-
8
- var _react = _interopRequireWildcard(require("react"));
9
-
10
- var _memoizerific = _interopRequireDefault(require("memoizerific"));
11
-
12
- var _api = require("@storybook/api");
13
-
14
- var _clientLogger = require("@storybook/client-logger");
15
-
16
- var _components = require("@storybook/components");
17
-
18
- var _constants = require("../constants");
19
-
20
- var _ColorIcon = require("../components/ColorIcon");
21
-
22
- var _helpers = require("../helpers");
23
-
24
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
25
-
26
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
27
-
28
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
29
-
30
- const createBackgroundSelectorItem = (0, _memoizerific.default)(1000)((id, name, value, hasSwatch, change, active) => ({
31
- id: id || name,
32
- title: name,
33
- onClick: () => {
34
- change({
35
- selected: value,
36
- name
37
- });
38
- },
39
- value,
40
- right: hasSwatch ? /*#__PURE__*/_react.default.createElement(_ColorIcon.ColorIcon, {
41
- background: value
42
- }) : undefined,
43
- active
44
- }));
45
- const getDisplayedItems = (0, _memoizerific.default)(10)((backgrounds, selectedBackgroundColor, change) => {
46
- const backgroundSelectorItems = backgrounds.map(({
47
- name,
48
- value
49
- }) => createBackgroundSelectorItem(null, name, value, true, change, value === selectedBackgroundColor));
50
-
51
- if (selectedBackgroundColor !== 'transparent') {
52
- return [createBackgroundSelectorItem('reset', 'Clear background', 'transparent', null, change, false), ...backgroundSelectorItems];
53
- }
54
-
55
- return backgroundSelectorItems;
56
- });
57
- const DEFAULT_BACKGROUNDS_CONFIG = {
58
- default: null,
59
- disable: true,
60
- values: []
61
- };
62
- const BackgroundSelector = /*#__PURE__*/(0, _react.memo)(() => {
63
- const backgroundsConfig = (0, _api.useParameter)(_constants.PARAM_KEY, DEFAULT_BACKGROUNDS_CONFIG);
64
- const [globals, updateGlobals] = (0, _api.useGlobals)();
65
- const globalsBackgroundColor = globals[_constants.PARAM_KEY]?.value;
66
- const selectedBackgroundColor = (0, _react.useMemo)(() => {
67
- return (0, _helpers.getBackgroundColorByName)(globalsBackgroundColor, backgroundsConfig.values, backgroundsConfig.default);
68
- }, [backgroundsConfig, globalsBackgroundColor]);
69
-
70
- if (Array.isArray(backgroundsConfig)) {
71
- _clientLogger.logger.warn('Addon Backgrounds api has changed in Storybook 6.0. Please refer to the migration guide: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md');
72
- }
73
-
74
- const onBackgroundChange = (0, _react.useCallback)(value => {
75
- updateGlobals({
76
- [_constants.PARAM_KEY]: Object.assign({}, globals[_constants.PARAM_KEY], {
77
- value
78
- })
79
- });
80
- }, [backgroundsConfig, globals, updateGlobals]);
81
-
82
- if (backgroundsConfig.disable) {
83
- return null;
84
- }
85
-
86
- return /*#__PURE__*/_react.default.createElement(_react.Fragment, null, /*#__PURE__*/_react.default.createElement(_components.WithTooltip, {
87
- placement: "top",
88
- trigger: "click",
89
- closeOnClick: true,
90
- tooltip: ({
91
- onHide
92
- }) => {
93
- return /*#__PURE__*/_react.default.createElement(_components.TooltipLinkList, {
94
- links: getDisplayedItems(backgroundsConfig.values, selectedBackgroundColor, ({
95
- selected
96
- }) => {
97
- if (selectedBackgroundColor !== selected) {
98
- onBackgroundChange(selected);
99
- }
100
-
101
- onHide();
102
- })
103
- });
104
- }
105
- }, /*#__PURE__*/_react.default.createElement(_components.IconButton, {
106
- key: "background",
107
- title: "Change the background of the preview",
108
- active: selectedBackgroundColor !== 'transparent'
109
- }, /*#__PURE__*/_react.default.createElement(_components.Icons, {
110
- icon: "photo"
111
- }))));
112
- });
113
- exports.BackgroundSelector = BackgroundSelector;
@@ -1,48 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.GridSelector = void 0;
7
-
8
- var _react = _interopRequireWildcard(require("react"));
9
-
10
- var _api = require("@storybook/api");
11
-
12
- var _components = require("@storybook/components");
13
-
14
- var _constants = require("../constants");
15
-
16
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
17
-
18
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
19
-
20
- const GridSelector = /*#__PURE__*/(0, _react.memo)(() => {
21
- const [globals, updateGlobals] = (0, _api.useGlobals)();
22
- const {
23
- grid
24
- } = (0, _api.useParameter)(_constants.PARAM_KEY, {
25
- grid: {
26
- disable: false
27
- }
28
- });
29
-
30
- if (grid?.disable) {
31
- return null;
32
- }
33
-
34
- const isActive = globals[_constants.PARAM_KEY]?.grid || false;
35
- return /*#__PURE__*/_react.default.createElement(_components.IconButton, {
36
- key: "background",
37
- active: isActive,
38
- title: "Apply a grid to the preview",
39
- onClick: () => updateGlobals({
40
- [_constants.PARAM_KEY]: Object.assign({}, globals[_constants.PARAM_KEY], {
41
- grid: !isActive
42
- })
43
- })
44
- }, /*#__PURE__*/_react.default.createElement(_components.Icons, {
45
- icon: "grid"
46
- }));
47
- });
48
- exports.GridSelector = GridSelector;
@@ -1,52 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.withBackground = void 0;
7
-
8
- var _addons = require("@storybook/addons");
9
-
10
- var _constants = require("../constants");
11
-
12
- var _helpers = require("../helpers");
13
-
14
- const withBackground = (StoryFn, context) => {
15
- const {
16
- globals,
17
- parameters
18
- } = context;
19
- const globalsBackgroundColor = globals[_constants.PARAM_KEY]?.value;
20
- const backgroundsConfig = parameters[_constants.PARAM_KEY];
21
- const selectedBackgroundColor = (0, _addons.useMemo)(() => {
22
- if (backgroundsConfig.disable) {
23
- return 'transparent';
24
- }
25
-
26
- return (0, _helpers.getBackgroundColorByName)(globalsBackgroundColor, backgroundsConfig.values, backgroundsConfig.default);
27
- }, [backgroundsConfig, globalsBackgroundColor]);
28
- const isActive = (0, _addons.useMemo)(() => selectedBackgroundColor && selectedBackgroundColor !== 'transparent', [selectedBackgroundColor]);
29
- const selector = context.viewMode === 'docs' ? `#anchor--${context.id} .docs-story` : '.sb-show-main';
30
- const backgroundStyles = (0, _addons.useMemo)(() => {
31
- const transitionStyle = 'transition: background-color 0.3s;';
32
- return `
33
- ${selector} {
34
- background: ${selectedBackgroundColor} !important;
35
- ${(0, _helpers.isReduceMotionEnabled)() ? '' : transitionStyle}
36
- }
37
- `;
38
- }, [selectedBackgroundColor, selector]);
39
- (0, _addons.useEffect)(() => {
40
- const selectorId = context.viewMode === 'docs' ? `addon-backgrounds-docs-${context.id}` : `addon-backgrounds-color`;
41
-
42
- if (!isActive) {
43
- (0, _helpers.clearStyles)(selectorId);
44
- return;
45
- }
46
-
47
- (0, _helpers.addBackgroundStyle)(selectorId, backgroundStyles, context.viewMode === 'docs' ? context.id : null);
48
- }, [isActive, backgroundStyles, context]);
49
- return StoryFn();
50
- };
51
-
52
- exports.withBackground = withBackground;
@@ -1,82 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.withGrid = void 0;
7
-
8
- var _tsDedent = _interopRequireDefault(require("ts-dedent"));
9
-
10
- var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
11
-
12
- var _addons = require("@storybook/addons");
13
-
14
- var _helpers = require("../helpers");
15
-
16
- var _constants = require("../constants");
17
-
18
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
19
-
20
- const deprecatedCellSizeWarning = (0, _utilDeprecate.default)(() => {}, (0, _tsDedent.default)`
21
- Backgrounds Addon: The cell size parameter has been changed.
22
-
23
- - parameters.grid.cellSize should now be parameters.backgrounds.grid.cellSize
24
- See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-grid-parameter
25
- `);
26
-
27
- const withGrid = (StoryFn, context) => {
28
- const {
29
- globals,
30
- parameters
31
- } = context;
32
- const gridParameters = parameters[_constants.PARAM_KEY].grid;
33
- const isActive = globals[_constants.PARAM_KEY]?.grid === true && gridParameters.disable !== true;
34
- const {
35
- cellAmount,
36
- cellSize,
37
- opacity
38
- } = gridParameters;
39
- const isInDocs = context.viewMode === 'docs';
40
- let gridSize;
41
-
42
- if (parameters.grid?.cellSize) {
43
- gridSize = parameters.grid.cellSize;
44
- deprecatedCellSizeWarning();
45
- } else {
46
- gridSize = cellSize;
47
- }
48
-
49
- const isLayoutPadded = parameters.layout === undefined || parameters.layout === 'padded'; // 16px offset in the grid to account for padded layout
50
-
51
- const defaultOffset = isLayoutPadded ? 16 : 0;
52
- const offsetX = gridParameters.offsetX ?? (isInDocs ? 20 : defaultOffset);
53
- const offsetY = gridParameters.offsetY ?? (isInDocs ? 20 : defaultOffset);
54
- const gridStyles = (0, _addons.useMemo)(() => {
55
- const selector = context.viewMode === 'docs' ? `#anchor--${context.id} .docs-story` : '.sb-show-main';
56
- const backgroundSize = [`${gridSize * cellAmount}px ${gridSize * cellAmount}px`, `${gridSize * cellAmount}px ${gridSize * cellAmount}px`, `${gridSize}px ${gridSize}px`, `${gridSize}px ${gridSize}px`].join(', ');
57
- return `
58
- ${selector} {
59
- background-size: ${backgroundSize} !important;
60
- background-position: ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px, ${offsetX}px ${offsetY}px !important;
61
- background-blend-mode: difference !important;
62
- background-image: linear-gradient(rgba(130, 130, 130, ${opacity}) 1px, transparent 1px),
63
- linear-gradient(90deg, rgba(130, 130, 130, ${opacity}) 1px, transparent 1px),
64
- linear-gradient(rgba(130, 130, 130, ${opacity / 2}) 1px, transparent 1px),
65
- linear-gradient(90deg, rgba(130, 130, 130, ${opacity / 2}) 1px, transparent 1px) !important;
66
- }
67
- `;
68
- }, [gridSize]);
69
- (0, _addons.useEffect)(() => {
70
- const selectorId = context.viewMode === 'docs' ? `addon-backgrounds-grid-docs-${context.id}` : `addon-backgrounds-grid`;
71
-
72
- if (!isActive) {
73
- (0, _helpers.clearStyles)(selectorId);
74
- return;
75
- }
76
-
77
- (0, _helpers.addGridStyle)(selectorId, gridStyles);
78
- }, [isActive, gridStyles, context]);
79
- return StoryFn();
80
- };
81
-
82
- exports.withGrid = withGrid;