Setting default parameters at runtime

[ollieread]

Description

When the route definitions are dumped out so Ziggy can work with them, it includes all current default parameters, but it doesn't have support for runtime default parameters.

I've built a multitenancy package that contains features that use route parameters to identify tenants. Within Laravel, I can set the default value for the route parameter once the tenant is identified, so that users don't have to provide its value when using route() etc.

Suggestion

Add controls to add or remove default route parameter values. I believe it just needs to be something that modifies _config.defaults and adds the mapping, but I'm not confident enough in my Typescript abilities to add it myself.

ziggy/src/js/Router.js

Lines 270 to 287 in 73abf72

	/**
	* Populate default parameters for the given route.
	*
	* @example
	* // with default parameters { locale: 'en', country: 'US' } and 'posts.show' route '{locale}/posts/{post}'
	* defaults(...); // { locale: 'en' }
	*
	* @param {Route} route
	* @return {Object} Default route parameters.
	*/
	_defaults(route) {
	return route.parameterSegments
	.filter(({ name }) => this._config.defaults[name])
	.reduce(
	(result, { name }, i) => ({ ...result, [name]: this._config.defaults[name] }),
	{},
	);
	}

[bakerkretzmar]

How exactly would you use this? Unless you're using Inertia the output of @routes would be reloaded on each request. I'm interested to see specific examples of what you'd do with this though.

[ollieread]

How exactly would you use this? Unless you're using Inertia the output of @routes would be reloaded on each request. I'm interested to see specific examples of what you'd do with this though.

The primary use-case that led me to this is specifically when using Inertia. It's also fine that it would be reloaded with each request.

To give you an example, imagine a route group like this that includes the vast majority of the sites routes:

Route::domain('{tenants_subdomain}.domain.tld')->group(function () {
    // Routes
});

The route parameter name is dynamic, as it was added on behalf of the tenants tenancy, and using the subdomain resolver. Its value can be found by calling Tenant::getTenantIdentifier(). Now, if the user wants to use one of these routes, they have to know the name of the route parameter, as well as the current tenants' identifier.

What I hope to do, is provide a small bit of code that users can add, which will automatically set the value for the tenants_subdomain route parameter, in the same way I do in Laravel. Here's the documentation explaining a bit about it on my end.

[bakerkretzmar]

The route parameter name is dynamic

What does this mean exactly? In your example isn't the route parameter name tenants_subdomain?

[daraghoshea]

I am currently facing this exact scenario also.

I am using Inertia.

• {team}/.. prefix in the route path to identify the team
• middleware to check the user has access to the team, and set URL::defaults(['team' => $request->route('team')]);

This works fine when the initial page load is on a {team}/.. route, because the middleware runs and ziggy loads the URL::defaults(...) values via @routes

However, if the user arrives on the login page, then is redirected to a {team}/.. route, then I get an error:

Error: Ziggy error: 'team' parameter is required for route ...

Is there a way to update the sharedData for partial reloads? Or a way to hook into it?

[vicheanath]

i also face the same problem, with multi tenancy, Yes Share data can solve the problem, but we need to hard code every route when we use. example route("users.index", { tenant : 'tenant1"}) it should able to set it globally. i saw some solution they said we can use @routes(['tenants' => $tenantSlug]) in app.blade.php but for me it not working.

[thaqebon]

See #567 (comment) about making the full Ziggy config (including defaults) available dynamically at runtime.