Skip to content

Commit

Permalink
refactor: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrgnhnt96 committed May 2, 2023
1 parent d4b87a8 commit 4d0e084
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,6 @@ final routes = GoRouter(

### Navigate to your paths

Go router is used in this example, but is not required.

```dart
AppPaths.home.path // '/home'
AppPaths.welcome.login.path // '/welcome/login'
Expand All @@ -133,14 +131,12 @@ AppPaths.users.user.define('Darth Vader').delete.path // '/users/Darth Vader/del
AppPaths.books.define('Star Wars').query({'first-trilogy-only': 'true'}).path // '/books/Star Wars?first-trilogy-only=true'
```

## Note

### Encoding
## Encoding

Calling the `path` member on a `Path` or `Param` will return the path as an encoded string automatically, including all params and queries.
All params and query params (keys and values) are encoded using `Uri.encodeComponent`.

[go_router]: https://pub.dev/packages/go_router
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis

0 comments on commit 4d0e084

Please sign in to comment.