Skip to content

Next.js: Move image configuration from FrameworkOptions to parameters #32639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
+9 −11
Open

Next.js: Move image configuration from FrameworkOptions to parameters #32639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e46dfc
fix: remove FrameworkOptions.image and move to NextJsParameters.nextj…
y-hsgw Oct 4, 2025
e25a02e
docs: update nextjs doc
y-hsgw Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion code/frameworks/nextjs/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ type BuilderName = CompatibleString<'@storybook/builder-webpack5'>;

export type FrameworkOptions = ReactOptions & {
nextConfigPath?: string;
image?: Partial<NextImage.ImageProps>;
builder?: BuilderOptions;
};

Expand Down Expand Up @@ -71,6 +70,9 @@ export interface NextJsParameters {

/** Next.js router configuration */
router?: Partial<NextRouter>;

/** Next.js image props */
image?: Partial<NextImage.ImageProps>;
};
}

Expand Down
16 changes: 6 additions & 10 deletions docs/get-started/frameworks/nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,9 +967,6 @@ export default {
framework: {
name: '@storybook/your-framework',
options: {
image: {
loading: 'eager',
},
nextConfigPath: path.resolve(process.cwd(), 'next.config.js'),
},
},
Expand All @@ -984,12 +981,6 @@ Type: `Record<string, any>`

Configure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For Next.js, available options can be found in the [Webpack builder docs](../../builders/webpack.mdx).

#### `image`

Type: `object`

Props to pass to every instance of `next/image`. See [next/image docs](https://nextjs.org/docs/pages/api-reference/components/image) for more details.

#### `nextConfigPath`

Type: `string`
Expand All @@ -1000,6 +991,12 @@ The absolute path to the `next.config.js` file. This is necessary if you have a

This framework contributes the following [parameters](../../writing-stories/parameters.mdx) to Storybook, under the `nextjs` namespace:

#### `image`

Type: `object`

Props to pass to every instance of `next/image`. See [next/image docs](https://nextjs.org/docs/pages/api-reference/components/image) for more details.

#### `appDirectory`

Type: `boolean`
Expand Down Expand Up @@ -1044,4 +1041,3 @@ Type:
```

The router object that is passed to the `next/router` context. See [Next.js's router docs](https://nextjs.org/docs/pages/building-your-application/routing) for more details.

Loading