Ziggy Laravel Package

Fixed

• Fix shared route bindings mutation in _substituteBindings by @pataar in https://github.com/tighten/ziggy/pull/875
• fix: handle falsy parameter values in _parse by @pataar in https://github.com/tighten/ziggy/pull/876

Changed

• Allow specifying the name of the typescript declaration file by @bakerkretzmar in https://github.com/tighten/ziggy/pull/872

Added

• Support route model binding and interfaces by @christian98 in https://github.com/tighten/ziggy/pull/854
• feat(typescript): add branded type for creating routes by @pataar in https://github.com/tighten/ziggy/pull/862
• Add JSON option to [@routes](https://github.com/routes) for improved CSP compatibility by @flexponsive in https://github.com/tighten/ziggy/pull/831

Fixed

• Fix current checks with encoded # in URL by @bakerkretzmar in https://github.com/tighten/ziggy/pull/863

Changed

• Replace qs by @benmccann in https://github.com/tighten/ziggy/pull/846

Fixed

• Fix type hinting for PHP 8.4 by @bodny in https://github.com/tighten/ziggy/pull/816
• Fix checking current route in strict mode by @bakerkretzmar in https://github.com/tighten/ziggy/pull/840

Changed

• Test on Laravel 12 by @shuvroroy in https://github.com/tighten/ziggy/pull/820
• Update extendability of Types.php by @rrmesquita in https://github.com/tighten/ziggy/pull/821

Fixed

• Fix current() type in strict mode by @bakerkretzmar in https://github.com/tighten/ziggy/pull/809

Added

• Support passing except/only args to ziggy command by @joshmanders in https://github.com/tighten/ziggy/pull/805

Fixed

• Redefine ParsedQs type by @bakerkretzmar in https://github.com/tighten/ziggy/pull/806
• Only limit route names when calling route() by @simon-tma in https://github.com/tighten/ziggy/pull/790

Fixed

• Fix deprecated implictly nullable parameter by @datlechin in https://github.com/tighten/ziggy/pull/792

Fixed

• Fix qs type dependencies

Added

• Add ability to strictly type check route names by @bakerkretzmar and @Andyuu in https://github.com/tighten/ziggy/pull/787

Fixed

• Fix type definition for route() with only options by @bram-pkg in https://github.com/tighten/ziggy/pull/786
• Fix queryParams return type by @bakerkretzmar in https://github.com/tighten/ziggy/pull/788

Changed

• Add note to use inject for vue 3 by @mhelaiwa in https://github.com/tighten/ziggy/pull/785
• Update README.md. by @choowx in https://github.com/tighten/ziggy/pull/782

Fixed

• Escape special regex characters when matching routes by @aguingand in https://github.com/tighten/ziggy/pull/766
• Fix params sometimes being double-decoded by @bakerkretzmar in https://github.com/tighten/ziggy/pull/778

Changed

• Optimize has() by @thomas-brx in https://github.com/tighten/ziggy/pull/770

Added

• Add ability to acess only the query params or the actual route params by @peter-emad99 in https://github.com/tighten/ziggy/pull/744

Changed

• Pest by @bakerkretzmar in https://github.com/tighten/ziggy/pull/756
• Laravel route change by @hasanablak in https://github.com/tighten/ziggy/pull/763
• Modernize some PHP syntax by @bakerkretzmar in https://github.com/tighten/ziggy/pull/757

Fixed

• Fix double slashes with domain params by @bakerkretzmar in https://github.com/tighten/ziggy/pull/754

Added

• Support Laravel Folio by @bakerkretzmar in https://github.com/tighten/ziggy/pull/733

Fixed

• Fix route().params type by @peter-emad99 in https://github.com/tighten/ziggy/pull/743

Added

• Improve generated types to include optional types by @alexmccabe in https://github.com/tighten/ziggy/pull/697

Fixed

• Fix Vue plugin on Vue 2 by @bakerkretzmar in https://github.com/tighten/ziggy/pull/738

Fixed

• Export the types file by @simon-tma in https://github.com/tighten/ziggy/pull/721

Fixed

• Fix event listener propagation by @bakerkretzmar in https://github.com/tighten/ziggy/pull/724

Fixed

• Add Vue plugin and React hook types by @bakerkretzmar in https://github.com/tighten/ziggy/pull/715

Fixed

• Fix package.json module and exports by @bakerkretzmar in https://github.com/tighten/ziggy/pull/714

Fixed

• Remove default export from type declarations by @bakerkretzmar in https://github.com/tighten/ziggy/pull/713

See UPGRADING for detailed upgrade instructions.

Changed

• Changed PHP package namespace from Tightenco\Ziggy to Tighten\Ziggy.
• Updated JavaScript package to only provide named exports.
• Moved Vue and React integrations to root of JavaScript module.
• Updated builds to only use ES Modules.
• Updated minimum dependency versions to Laravel 9 and PHP 8.1.

Removed

• Made makeDirectory method of CommandRouteGenerator class private.
• Removed deprecated JavaScript check() method.

Added

• Test on Laravel 11 by @shuvroroy in https://github.com/tighten/ziggy/pull/709

Fixed

• Fix route().current() with encoded characters by @bakerkretzmar in https://github.com/tighten/ziggy/pull/668
• Fix retrieving ziggys config from an api endpoint link in readme by @RomainMazB in https://github.com/tighten/ziggy/pull/694
• Fix route().current() with nested/object query params by @bakerkretzmar in https://github.com/tighten/ziggy/pull/712

Changed

• Enable provenance for npm package by @saibotk in https://github.com/tighten/ziggy/pull/684
• Handle generated file extensions more robustly by @bakerkretzmar in https://github.com/tighten/ziggy/pull/687

Fixed

• Update: Correction of some spellings and articles in the Readme file. by @prince-noman in https://github.com/tighten/ziggy/pull/678
• Fix route().current() with encoded characters by @bakerkretzmar in https://github.com/tighten/ziggy/pull/668

Changed

• Update Readme, formatting, and testing setup by @bakerkretzmar in https://github.com/tighten/ziggy/pull/675

Added

• Add type declarations and ziggy.d.ts generation by @lmeysel and @bakerkretzmar in https://github.com/tighten/ziggy/pull/664

Added

• Add useRoute() React hook by @bakerkretzmar in https://github.com/tighten/ziggy/pull/473

Fixed

• URL-encode fewer special characters inside in route parameters by @bakerkretzmar in https://github.com/tighten/ziggy/pull/662
• Fix empty root URL with absolute: false by @bakerkretzmar in https://github.com/tighten/ziggy/pull/667

Fixed

• Make slash "not encoding" less restrictive by @aguingand in https://github.com/tighten/ziggy/pull/661

Fixed

• Fix numeric route names by @bakerkretzmar https://github.com/tighten/ziggy/pull/658

Added

• Add 'ziggy.output.path' config option by @mhelaiwa https://github.com/tighten/ziggy/pull/633

Added

• Add Vite instructions to README.md by @fullstackfool https://github.com/tighten/ziggy/pull/627

Fixed

• Trim slashes between origin and optional first param by @bakerkretzmar in https://github.com/tighten/ziggy/pull/637
• Fix route().params not being decoded by @Tofandel in https://github.com/tighten/ziggy/pull/610

Fixed

• Check for overridden getKeyName() and $primaryKey by @Jared0430 in https://github.com/tighten/ziggy/pull/630

Added

• Add support for negating route filter patterns with ! by @bakerkretzmar in https://github.com/tighten/ziggy/pull/559

Changed

• Test on PHP 8.2 by @bakerkretzmar in https://github.com/tighten/ziggy/pull/584

Fixed

• Allow null as entire params argument by @bakerkretzmar in https://github.com/tighten/ziggy/pull/582

Fixed

• Use global regex instead of replaceAll for better browser support by @bakerkretzmar in https://github.com/tighten/ziggy/pulls/548

Fixed

• Remove dead code by @Tofandel in https://github.com/tighten/ziggy/pull/525
• Fix route().current() with 'wheres' that include regex start/end anchors by @bakerkretzmar in https://github.com/tighten/ziggy/pull/535
• Fix inherited custom route key name detection by @bakerkretzmar in https://github.com/tighten/ziggy/pull/540

Added

• Allow custom output via formatters by @jaulz in https://github.com/tighten/ziggy/pull/483
• Add Vue 3 provide/inject support to the Vue plugin by @c-fitzmaurice in https://github.com/tighten/ziggy/pull/518

Fixed

• Encode non-slash characters in wildcard last parameter by @rodrigopedra in https://github.com/tighten/ziggy/pull/507
• Update JS route matching to take 'wheres' into account by @Tofandel in https://github.com/tighten/ziggy/pull/514

Added

• Test on PHP 8.1 by @bakerkretzmar in https://github.com/tighten/ziggy/pull/484
• Don't encode slashes in wildcard last parameter by @bakerkretzmar in https://github.com/tighten/ziggy/pull/500

Fixed

• Ignore route action parameters without URI segments by @jaulz in https://github.com/tighten/ziggy/pull/482

Fixed

• Fix route().current() matching route names with multiple periods (#466)

Fixed

• Fix undefined error if there's no global Ziggy variable (#462)
• Fix payload caching for Octane (#460)

Added

• Add support for parameters inside single route segments (#444)

Fixed

• Fix nested object query params (#451)

Fixed

• Fix route model binding with abstract class (#445)

Fixed

• Fix property mangling and implement ES5 compatibility (#442)

Fixed

• Revert (d781b16)

Fixed

• Remove Babel preset to correctly transpile to ES5 by default (d781b16)

Changed

• Use Object.assign() to merge routes (#429)

Added

• Make location configurable (adds better support for SSR) (#432)

Added

• Add Vue plugins (#407, #424)

Added

• Prepare for Laravel Octane (#415)

Added

• Add support for appending 'extra' parameters to the query string (#390)

Changed

• Remove source maps (#395)

Fixed

• Use Laravel's Reflector class to get model parameter class name (#396)

Fixed

• Fix bug where route().current() could incorrectly return true on URLs with no parameters (#377)
• Fix several other bugs in route().current() with params (#379)
• Revert #334, default Ziggy's url back to url('/') instead of the APP_URL environment variable (#386)

Fixed

• Filter out unnamed cached routes with randomly generated names (#370)
• Fix collision with JavaScript built-in method names like shift by casting empty defaults to an object (#371)

Fixed

• Make ziggy:generate URL behaviour consistent with Ziggy class and Blade directive (#361)
• Fix route().current() error on unknown/unnamed routes (#362)

Fixed

• Fix route().current() on routes at the domain root (#356)

Added

• Document the check() method (#294) and how to install and use Ziggy via npm and over a CDN (#299)
• Add support for custom scoped route model binding, e.g. /users/{user}/posts/{post:slug} (#307)
• Add support for implicit route model binding (#315)
• Add support for passing parameters to current() to check against the current URL in addition to the route name (#330)

Changed

• ⚠️ Update ziggy:generate output path for Laravel 5.7+ resources directory structure, thanks [@Somethingideally](https://github.com/Somethingideally)! (#269)
• ⚠️ Update automatic id parameter detection to check for higher priority named route parameters and allow passing id as a query parameter (#301)
• ⚠️ Rename the RoutePayload class to Ziggy and remove its compile method in favour of constructing a new instance and calling ->toArray() or ->toJson() (#305)
  • Resolve the application router instance internally instead of passing it into the constructor – new Ziggy(...) now takes only 2 arguments, $group and $url
  • Change the default value of basePort from false to null
  • Remove the getRoutePayload() methods on the BladeRouteGenerator and CommandRouteGenerator classes
• ⚠️ Rename all whitelist and blacklist functionality to only and except (#300)
• Use Jest instead of Mocha for JS tests (#309)
• Use microbundle instead of Webpack to build and distribute Ziggy (#312)
• ⚠️ Default Ziggy's baseUrl to the value of the APP_URL environment variable instead of url('/') (#334)
• ⚠️ Return a literal string from the route() function when any arguments are passed to it (#336)
• ⚠️ Rename namedRoutes → routes, defaultParameters → defaults, baseUrl → url, and basePort → port (#338)
• ⚠️ Make the filter() method on the Ziggy class return an instance of that class instead of a collection of routes (#341)
• ⚠️ Make the nameKeyedRoutes(), resolveBindings(), applyFilters(), and group() methods on the Ziggy class, and the generate() method on the CommandRouteGenerator class, private (#341)
• ⚠️ Export from index.js instead of route.js (#344)
• ⚠️ Encode boolean query parameters as integers (#345)
• ⚠️ Ensure .current() respects the value of the absolute option (#353)

Deprecated

• Deprecate the with() and check() methods (#330)

Removed

• ⚠️ Remove Route Facade macros Route::only() and Route::except() (previously Route::whitelist() and Route::blacklist()) (#306)
• ⚠️ Remove the following undocumented public properties and methods from the Router class returned by the route() function (#330):
  • name, absolute, ziggy, urlBuilder, template, urlParams, queryParams, and hydrated
  • normalizeParams(), hydrateUrl(), matchUrl(), constructQuery(), extractParams(), parse(), and trimParam()
• ⚠️ Remove the UrlBuilder class (#330)
• ⚠️ Remove the url() method now that route(...) returns a string (#336)
• ⚠️ Remove the baseDomain and baseProtocol properties on the Ziggy config object (#337)
• ⚠️ Remove the appendRouteToList(), isListedAs(), except(), and only() methods from the Ziggy class (#341)

Fixed

• Fix automatic id parameter detection by also excluding routes with an optional id parameter ({id?}), thanks [@Livijn](https://github.com/Livijn)! (#263)
• Fix port not being added to URL for routes with subdomains (#293)
• Fix getting parameters of routes in apps installed in subfolders (#302)
• Ensure fallback routes are always last, thanks [@davejamesmiller](https://github.com/davejamesmiller)! (#310)
• Allow getting the route name with current() when the current URL has a query string (#330)

Fixed

• Fix escaping of . characters in the current() method, thanks [@davejamesmiller](https://github.com/davejamesmiller)! (#296)

Added

• Add support for passing a CSP nonce attribute to the [@routes](https://github.com/routes) Blade directive to be set on the script tag, thanks [@tminich](https://github.com/tminich)! (#287)

Changed

• Improve support for using Ziggy with server-side rendering, thanks [@emielmolenaar](https://github.com/emielmolenaar)! (#260)
• Avoid resolving the Blade compiler unless necessary, thanks [@axlon](https://github.com/axlon)! (#267)
• Use dist/js/route.js as the npm package's main target, thanks [@ankurk91](https://github.com/ankurk91) and [@benallfree](https://github.com/benallfree)! (#276)
• Readme and quality-of-life improvements (#289)

Fixed

• Ensure Ziggy's assets are always generated in the correct location (#290)

For previous changes see the Releases page.