Skip to content
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.

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

Next.js: Add typing for NextImage to main framework options type #27105

Merged
merged 2 commits into from
May 14, 2024

Conversation

valentinpalkovic
Copy link
Contributor

Closes #25397

What I did

I've added the image option type to Next.js' framework options.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a Next.js sandbox
  2. Try to add the image option to frameworks.options.
  3. TypeScript shouldn't complain

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@valentinpalkovic valentinpalkovic self-assigned this May 13, 2024
@valentinpalkovic valentinpalkovic added bug typescript nextjs ci:daily Run the CI jobs that normally run in the daily job. ci:normal and removed ci:normal labels May 13, 2024
Copy link

nx-cloud bot commented May 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e21f7d4. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic marked this pull request as ready for review May 13, 2024 12:15

type FrameworkName = '@storybook/nextjs';
type BuilderName = '@storybook/builder-webpack5';

export type FrameworkOptions = ReactOptions & {
nextConfigPath?: string;

image?: NextImage.ImageProps;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this compliant with Next 13 and 14? If so, all good!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. It is Next.js 13 compatible. I've added a Partial<NextImage.ImageProps> wrapper, thought, to mark all keys as optional.

@valentinpalkovic valentinpalkovic merged commit 46646d2 into next May 14, 2024
111 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/nextjs-add-image-typing branch May 14, 2024 14:00
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 14, 2024
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…typing

Next.js: Add typing for NextImage to main framework options type

(cherry picked from commit 46646d2)
@github-actions github-actions bot mentioned this pull request May 15, 2024
9 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:daily Run the CI jobs that normally run in the daily job. nextjs patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Page needs to be updated for new Custom mocking method for next/image in Storybook v7
3 participants