fix(useOverlay): use original props when not provided to open

[genu]

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR improves the way props are handled. Since props can be set on create and on open, I believe the expectation is that when props are not passed to open, then the ones passed to create are used. Furthermore, when passing props to open it should not override the original props that were passed to create, they should only be applied for that instance.

Take this example:

When creating an overlay like so:

const modal = overlay.create(MyModal, {
  props: {
    count: 12
  }
})

const openSecond = () => {
   modal.open({ count: 22})
}

const openOriginal = () => {
   modal.open()
}

If we open in this order:

1. openSecond // count is 22
2. openOriginal // count is still 22 because the first time we called open, the props were overridden

The expected behavior is that when calling open() without props, it would always default to using the props that were set at creation.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[pkg-pr-new]

npm i https://pkg.pr.new/@nuxt/ui@4269

commit: 0458249

[Shedevro]

@benjamincanac @genu,
Hello guys.
I have this code

  overlay.create(PdfViewerDialog, {
      props: {
        files,
      },
      defaultOpen: true,
      destroyOnClose: true,
    });

Now I'm getting error and unable to use useOverlay().

[Vue warn]: Missing required prop: "files" 
  at <PdfViewerDialog key= Symbol() ref_for=true open=true  ... >

It works fine with public v3.

[genu]

@Shedevro is that issue related specifically to this PR?

In my testing, I'm not able to reproduce the issue.

Do you mind opening up a issue with a reproduction?

[Shedevro]

@genu
Yes, it's related to this PR.
I'm using Vue.
I've downgraded to the previous commit (09151df) and it works fine.
I don't think creating an issue is a good idea cuz this is not a public version.
Reproduction is simple - it's just overlay.create() call with a component with props.

[Shedevro]

@genu
I don't think I understood your code well. But you just pass props: {} on overlay open.
Note that I'm passing defaultOpen: true

[genu]

@Shedevro Can you verify if the issue is fixed in above PR?

[Shedevro]

@genu it works now, thank you.