Return page object after Inertia.visit about inertia

[steven-lury]

@reinink onSuccess or other eventListener doesn't work in my project but when I use then it works. Do you have any idea

[reinink]

@sebastiandedeyne Is this still an issue in React, or have you found a sensible workaround here?

I ask because we've deprecated the visit promises in favour of the new event callbacks. However, if this problem still exists, we could potentially return the page object to the onSuccess() callback.

[sebastiandedeyne]

This is still an issue. I think the onSuccess callback is a good solution to this.

Maybe the new event system could provide a workaround, but I think that'd be a weird place to do that.

[reinink]

Yeah, okay cool. I think we can make this happen.

Next question then, should the onSuccess() callback get the whole page object (url, version, props), or just the props?

Option 1 (entire page object)

return onSuccess(this.page)

Option 2 (props only)

return onSuccess(this.page.props)

Option 3 (treat props as the page, but include the url and version)

return onSuccess({
  page: this.page.props,
  url: this.page.url,
  version: this.page.version,
})

So, this is tricky, because right now in the Vue.js adapter, $page is actually just the props. We made this decision to avoid having to do $page.props every time. However, there are times where having access to the URL would be nice ($page.url), so I've considered adding a $url property as well.

Either way...do we need to be consistent here?

[reinink]

To be honest, I kind of hate that we ever scoped page.props to $page in Vue.js. Yes, it's a nice convenience, but in reality I think it confuses what the "page" object is in Inertia.js. I kind of feel like we should move toward not doing this, and MAYBE even consider making this a change in the Vue.js adapter.

[reinink]

Okay, onSuccess() now receives the page object.

Considering this issue resolves. 🙌

[claudiodekker]

@steven-lury Probably you're using an outdated version of Inertia, as the onSuccess and other event listeners were introduced in @inertiajs/inertia version 0.3.0: https://github.com/inertiajs/inertia/releases/tag/v0.3.0

Could you try updating both the @inertiajs/inertia package in your application, as well as your stack-specific (react, vue or svelte) Inertia adapter? I believe that should solve your issue.

[grantholle]

I haven't found the reasoning on deprecating promises. Could someone elaborate for me?

Edit: Moving to discussions, sorry for the spam