storybook Next.js: Support getImageProps API

Next.js: Support getImageProps API

Open piratetaco opened this issue 5 months ago • 6 comments

Closes https://github.com/storybookjs/storybook/discussions/23588 Closes https://github.com/storybookjs/storybook/issues/24675

What I did

in this pull request, Next made getImageProps a stable member of the Image api. ~~This is the minimum required work to forward that through the Next format mock in a future-facing manner in case Next were to expose any additional members at this path.~~ This adds a getImageProps mock just like the mock NextImage that leverages the preset defaultLoader so that images all properly load when using this.

Open to changes if desired!

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!

Screenshot of issue: Screenshot 2024-01-24 at 10 48 52 AM

screenshot after change: Screenshot 2024-01-24 at 10 59 17 AM

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>

Jan 24 '24 17:01 piratetaco

Thank you so much for your contribution!

Could you add a story? Then we can cover and automatically test the behaviour. The best place to add one is to create a new story here: https://github.com/storybookjs/storybook/tree/next/code/frameworks/nextjs/template/stories_nextjs-default-ts. These stories are automatically picked up by Chromatic, which is set up for the Next.js sandboxes.

Jan 24 '24 19:01 valentinpalkovic

added! Hopefully it's formatted right and whatnot. Trying to follow what appears like convention but using the browser for this acc. Let me know if there's anything beyond this that you want added/changed!

Jan 25 '24 15:01 piratetaco

@valentinpalkovic The next version in storybook seems to be a bit too low to write the story. I accounted for this in the import and later destructuring in the fix, but right now I don't think the story will work without also bumping storybooks next version two majors. Which I guess explains why only the legacy image has a story today. What would you like me to do?

Jan 25 '24 17:01 piratetaco

will it be available for sb 7 or 8?