Skip to content

Commit 78f3d08

Browse files
authored
Merge pull request storybookjs#35087 from yatishgoel/fix/15923-viewport-defaultviewport-deprecation
Viewport: Warn when legacy `defaultViewport` parameter is used
2 parents da0e18e + 2824da8 commit 78f3d08

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

code/core/src/viewport/useViewport.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { useCallback, useEffect, useMemo, useRef } from 'react';
22

3+
import { deprecate } from 'storybook/internal/client-logger';
34
import type { Globals } from 'storybook/internal/csf';
45

56
import { useGlobals, useParameter, useStorybookApi } from 'storybook/manager-api';
@@ -157,6 +158,17 @@ export const useViewport = () => {
157158
const parameter = useParameter<ViewportParameters['viewport']>(PARAM_KEY);
158159
const [globals, updateGlobals, storyGlobals, userGlobals] = useGlobals();
159160

161+
useEffect(() => {
162+
if (parameter && 'defaultViewport' in parameter) {
163+
const value = (parameter as { defaultViewport?: unknown }).defaultViewport;
164+
deprecate(
165+
`The \`viewport.defaultViewport\` parameter was removed in Storybook 10. ` +
166+
`Use \`globals: { viewport: ${JSON.stringify(value)} }\` instead, ` +
167+
`or run \`npx storybook automigrate\` to update your code automatically.`
168+
);
169+
}
170+
}, [parameter]);
171+
160172
const { options = MINIMAL_VIEWPORTS, disable = false } = parameter || {};
161173
const { name, type, width, height, value, option, isCustom, isDefault, isLocked, isRotated } =
162174
parseGlobals(

0 commit comments

Comments
 (0)