22 KiB
22 KiB
Changelog
All notable changes to this project will be documented in this file.
This project adheres to Semantic Versioning, and the format of this changelog is based on Keep a Changelog.
Breaking changes are marked with ⚠️.
Unreleased
v2.5.3 - 2025-05-17
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
v2.5.2 - 2025-02-27
Changed
- Test on Laravel 12 by @shuvroroy in https://github.com/tighten/ziggy/pull/820
- Update extendability of
Types.phpby @rrmesquita in https://github.com/tighten/ziggy/pull/821
v2.5.1 - 2025-01-31
Fixed
- Fix
current()type in strict mode by @bakerkretzmar in https://github.com/tighten/ziggy/pull/809
v2.5.0 - 2025-01-22
Added
- Support passing except/only args to ziggy command by @joshmanders in https://github.com/tighten/ziggy/pull/805
Fixed
- Redefine
ParsedQstype 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
v2.4.2 - 2025-01-02
Fixed
- Fix deprecated implictly nullable parameter by @datlechin in https://github.com/tighten/ziggy/pull/792
v2.4.1 - 2024-11-21
Fixed
- Fix
qstype dependencies
v2.4.0 - 2024-11-09
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
queryParamsreturn 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
v2.3.1 - 2024-10-17
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
v2.3.0 - 2024-07-21
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
v2.2.1 - 2024-05-16
Fixed
- Fix double slashes with domain params by @bakerkretzmar in https://github.com/tighten/ziggy/pull/754
v2.2.0 - 2024-05-16
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
v2.1.0 - 2024-03-26
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
v2.0.5 - 2024-03-19
Fixed
- Export the types file by @simon-tma in https://github.com/tighten/ziggy/pull/721
v2.0.4 - 2024-03-05
Fixed
- Fix event listener propagation by @bakerkretzmar in https://github.com/tighten/ziggy/pull/724
v2.0.3 - 2024-02-20
Fixed
- Add Vue plugin and React hook types by @bakerkretzmar in https://github.com/tighten/ziggy/pull/715
v2.0.2 - 2024-02-20
Fixed
- Fix package.json module and exports by @bakerkretzmar in https://github.com/tighten/ziggy/pull/714
v2.0.1 - 2024-02-20
Fixed
- Remove default export from type declarations by @bakerkretzmar in https://github.com/tighten/ziggy/pull/713
v2.0.0 - 2024-02-20
See UPGRADING for detailed upgrade instructions.
Changed
- Changed PHP package namespace from
Tightenco\ZiggytoTighten\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
makeDirectorymethod ofCommandRouteGeneratorclass private. - Removed deprecated JavaScript
check()method.
v1.8.2 - 2024-02-20
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
v1.8.1 - 2023-10-12
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
v1.8.0 - 2023-10-06
Added
- Add type declarations and
ziggy.d.tsgeneration by @lmeysel and @bakerkretzmar in https://github.com/tighten/ziggy/pull/664
v1.7.0 - 2023-10-04
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: falseby @bakerkretzmar in https://github.com/tighten/ziggy/pull/667
v1.6.2 - 2023-08-18
Fixed
- Make slash "not encoding" less restrictive by @aguingand in https://github.com/tighten/ziggy/pull/661
v1.6.1 - 2023-08-04
Fixed
- Fix numeric route names by @bakerkretzmar https://github.com/tighten/ziggy/pull/658
v1.6.0 - 2023-05-12
Added
- Add
'ziggy.output.path'config option by @mhelaiwa https://github.com/tighten/ziggy/pull/633
v1.5.2 - 2023-05-05
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().paramsnot being decoded by @Tofandel in https://github.com/tighten/ziggy/pull/610
v1.5.1 - 2023-04-22
Fixed
- Check for overridden
getKeyName()and$primaryKeyby @Jared0430 in https://github.com/tighten/ziggy/pull/630
v1.5.0 - 2022-09-23
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
nullas entire params argument by @bakerkretzmar in https://github.com/tighten/ziggy/pull/582
v1.4.6 - 2022-04-08
Fixed
- Use global regex instead of
replaceAllfor better browser support by @bakerkretzmar in https://github.com/tighten/ziggy/pulls/548
v1.4.5 - 2022-03-25
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
v1.4.4 - 2022-03-11
Added
- Allow custom output via formatters by @jaulz in https://github.com/tighten/ziggy/pull/483
- Add Vue 3
provide/injectsupport 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
v1.4.3 - 2022-01-28
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
v1.4.2 - 2021-10-01
Fixed
- Fix
route().current()matching route names with multiple periods (#466)
v1.4.1 - 2021-09-24
Fixed
- Fix
undefinederror if there's no globalZiggyvariable (#462) - Fix payload caching for Octane (#460)
v1.4.0 - 2021-08-25
Added
- Add support for parameters inside single route segments (#444)
v1.3.6 - 2021-08-25
Fixed
- Fix nested object query params (#451)
v1.3.5 - 2021-07-20
Fixed
- Fix route model binding with abstract class (#445)
v1.3.4 - 2021-07-06
Fixed
- Fix property mangling and implement ES5 compatibility (#442)
v1.3.3 - 2021-07-02
Fixed
- Revert (d781b16)
v1.3.2 - 2021-07-01
Fixed
- Remove Babel preset to correctly transpile to ES5 by default (d781b16)
v1.3.1 - 2021-06-19
Changed
- Use
Object.assign()to merge routes (#429)
v1.3.0 - 2021-06-17
Added
- Make
locationconfigurable (adds better support for SSR) (#432)
v1.2.0 - 2021-05-24
Added
v1.1.0 - 2021-04-02
Added
- Prepare for Laravel Octane (#415)
v1.0.5 - 2021-02-05
Added
- Add support for appending 'extra' parameters to the query string (#390)
Changed
- Remove source maps (#395)
Fixed
- Use Laravel's
Reflectorclass to get model parameter class name (#396)
v1.0.4 - 2020-12-06
Fixed
- Fix bug where
route().current()could incorrectly returntrueon URLs with no parameters (#377) - Fix several other bugs in
route().current()with params (#379) - Revert #334, default Ziggy's
urlback tourl('/')instead of theAPP_URLenvironment variable (#386)
v1.0.3 - 2020-11-20
Fixed
- Filter out unnamed cached routes with randomly generated names (#370)
- Fix collision with JavaScript built-in method names like
shiftby casting emptydefaultsto an object (#371)
v1.0.2 - 2020-11-13
Fixed
- Make
ziggy:generateURL behaviour consistent with Ziggy class and Blade directive (#361) - Fix
route().current()error on unknown/unnamed routes (#362)
v1.0.1 - 2020-11-10
Fixed
- Fix
route().current()on routes at the domain root (#356)
v1.0.0 - 2020-11-06
Added
- Document the
check()method (#294) and how to install and use Ziggy vianpmand 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:generateoutput path for Laravel 5.7+resourcesdirectory structure, thanks @Somethingideally! (#269) - ⚠️ Update automatic
idparameter detection to check for higher priority named route parameters and allow passingidas a query parameter (#301) - ⚠️ Rename the
RoutePayloadclass toZiggyand remove itscompilemethod 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,$groupand$url - Change the default value of
basePortfromfalsetonull - Remove the
getRoutePayload()methods on theBladeRouteGeneratorandCommandRouteGeneratorclasses
- Resolve the application router instance internally instead of passing it into the constructor –
- ⚠️ Rename all
whitelistandblacklistfunctionality toonlyandexcept(#300) - Use Jest instead of Mocha for JS tests (#309)
- Use microbundle instead of Webpack to build and distribute Ziggy (#312)
- ⚠️ Default Ziggy's
baseUrlto the value of theAPP_URLenvironment variable instead ofurl('/')(#334) - ⚠️ Return a literal string from the
route()function when any arguments are passed to it (#336) - ⚠️ Rename
namedRoutes→routes,defaultParameters→defaults,baseUrl→url, andbasePort→port(#338) - ⚠️ Make the
filter()method on theZiggyclass return an instance of that class instead of a collection of routes (#341) - ⚠️ Make the
nameKeyedRoutes(),resolveBindings(),applyFilters(), andgroup()methods on theZiggyclass, and thegenerate()method on theCommandRouteGeneratorclass, private (#341) - ⚠️ Export from
index.jsinstead ofroute.js(#344) - ⚠️ Encode boolean query parameters as integers (#345)
- ⚠️ Ensure
.current()respects the value of theabsoluteoption (#353)
Deprecated
- Deprecate the
with()andcheck()methods (#330)
Removed
- ⚠️ Remove
RouteFacade macrosRoute::only()andRoute::except()(previouslyRoute::whitelist()andRoute::blacklist()) (#306) - ⚠️ Remove the following undocumented public properties and methods from the
Routerclass returned by theroute()function (#330):name,absolute,ziggy,urlBuilder,template,urlParams,queryParams, andhydratednormalizeParams(),hydrateUrl(),matchUrl(),constructQuery(),extractParams(),parse(), andtrimParam()
- ⚠️ Remove the
UrlBuilderclass (#330) - ⚠️ Remove the
url()method now thatroute(...)returns a string (#336) - ⚠️ Remove the
baseDomainandbaseProtocolproperties on the Ziggy config object (#337) - ⚠️ Remove the
appendRouteToList(),isListedAs(),except(), andonly()methods from theZiggyclass (#341)
Fixed
- Fix automatic
idparameter detection by also excluding routes with an optionalidparameter ({id?}), thanks @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! (#310)
- Allow getting the route name with
current()when the current URL has a query string (#330)
v0.9.4 - 2020-06-05
Fixed
- Fix escaping of
.characters in thecurrent()method, thanks @davejamesmiller! (#296)
v0.9.3 - 2020-05-08
Added
- Add support for passing a CSP
nonceattribute to the@routesBlade directive to be set on the script tag, thanks @tminich! (#287)
Changed
- Improve support for using Ziggy with server-side rendering, thanks @emielmolenaar! (#260)
- Avoid resolving the Blade compiler unless necessary, thanks @axlon! (#267)
- Use
dist/js/route.jsas the npm package's main target, thanks @ankurk91 and @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.