Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Router class behavior in README #815

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open

Clarify Router class behavior in README #815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ route().current('events.*'); // true
route().current('events.show'); // false
```

> Note: If you [filter which routes are sent to Ziggy on the frontend](#filtering-routes), only those routes will be available to the `Router` class on the frontend. As a result, calling `route().current()` on a route that has been filtered out will return `undefined`.

`route().current()` optionally accepts parameters as its second argument, and will check that their values also match in the current URL:

```js
Expand Down