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

Add deepMerge Support for Merging Nested Arrays and Objects in Props #2069

Merged
merged 7 commits into from
Apr 9, 2025

Conversation

HichemTab-tech
Copy link
Contributor

@HichemTab-tech HichemTab-tech commented Oct 26, 2024

This PR introduces support for deepMerge functionality in Inertia.js, enabling developers to merge nested arrays and objects within props when rendering pages. This is particularly useful for situations where complex data structures, such as pagination objects or deeply nested configuration objects, need to be updated incrementally.

Why This Is Useful:

Consider a scenario where you have a pagination object that contains nested properties like data, meta, and links:

{
  data: [/* items */],
  meta: { /* pagination metadata */ },
  links: { /* pagination links */ }
}

With deepMerge, the data array can be properly merged by appending new items, while other nested properties like meta and links are also updated incrementally. This ensures that only the necessary parts of the pagination object are modified without replacing the entire object, which can help maintain the consistency of the data across requests.

Related PR:

This PR works in conjunction with the newly added deep merging logic in the Inertia-laravel repository. Please see inertia-laravel PR #679 for details on the server-side implementation.

Fixes #2068

Add support for deep merging specified properties in page responses by introducing `deepMergeProps`. This ensures that nested objects and arrays are correctly merged instead of being overwritten, enhancing the flexibility and consistency of data handling.
This commit introduces the deepMergeProps feature in the Vue3 application, allowing for more comprehensive property merging. A corresponding test has been created to ensure the functionality operates as expected. Additionally, server routing is updated to support deepMergeProps.
Changed the component from 'DeepMergeProps' to 'MergeProps' in the /deep-merge-props route handler. This aligns the route's component usage with the updated naming conventions in the project.
Changed the component from 'DeepMergeProps' to 'MergeProps' in the /deep-merge-props route handler. This aligns the route's component usage with the updated naming conventions in the project.
@HichemTab-tech
Copy link
Contributor Author

Hi, any progress here ?! We really need this feature enhancement. Thanks.

@michaelstivala
Copy link

Are there any plans to merge this in?

@HichemTab-tech
Copy link
Contributor Author

Are there any plans to merge this in?

No idea my friend :")

@oliverbj
Copy link

Any update on this? :)

@HichemTab-tech
Copy link
Contributor Author

HichemTab-tech commented Mar 25, 2025

Any update on this? :)

Not at the moment, but @joetannenbaum said he will check all PRs during this next month so don't worry ;).

@rori-tallbert41
Copy link

@HichemTab-tech @joetannenbaum anything new one this ??

@joetannenbaum
Copy link
Contributor

Hi everyone. This is on my list today 🙂

@joetannenbaum
Copy link
Contributor

Great stuff, thank you @HichemTab-tech! This will go out late tomorrow in a release with some other PRs.

@joetannenbaum joetannenbaum merged commit 165b087 into inertiajs:master Apr 9, 2025
6 checks passed
@HichemTab-tech
Copy link
Contributor Author

Great stuff, thank you @HichemTab-tech! This will go out late tomorrow in a release with some other PRs.

Thanks @joetannenbaum ! Here's also the docs PR inertiajs.com#404 to reflect the new deepMerge() behavior and clarify when to use it vs merge() — hope it helps keep things clear for devs!

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.

Inertia::merge() Improperly Merges Pagination Objects in Inertia v2
5 participants