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

feat: add render hook support for multiple arguments #1386

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

imevanc
Copy link

@imevanc imevanc commented Mar 12, 2025

What: Add render hook support for multiple arguments

Why: renderHook only supports a single argument via initialProps, making it hard to test hooks with multiple parameters. This PR introduces initialArgs to allow passing multiple arguments directly, improving flexibility and reducing workarounds.

How:

  1. Added initialArgs support → Spreads arguments into the hook.
  2. Updated rerender → Now accepts multiple parameters.
  3. Ensured backward compatibility → initialProps remains unchanged.
  4. Throws an error if both initialProps and initialArgs are used.
  5. Added tests & updated docs → Validates behavior and documents usage.

Issue: #1350

Checklist:

  • Documentation added to the
    docs site
  • Tests
  • TypeScript definitions updated
  • Ready to be merged

Copy link

codesandbox-ci bot commented Mar 12, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 42c12ac:

Sandbox Source
react-testing-library-examples Configuration

@imevanc
Copy link
Author

imevanc commented Mar 12, 2025

@eps1lon - awaiting your feedback 🧑‍💻

@imevanc
Copy link
Author

imevanc commented Mar 14, 2025

@danielrentz - anything to add ?

Copy link

@danielrentz danielrentz left a comment

Choose a reason for hiding this comment

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

TS typings

@imevanc
Copy link
Author

imevanc commented Mar 21, 2025

@Hardanish-Singh - just rebased, can you please thumb it again?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants