Add useQueryParams usage example in README

WeAreAthlon · Feb 18, 2025 · 5987bbc · 5987bbc
1 parent 44ba4aa
commit 5987bbc
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/routable_builder/README.md b/routable_builder/README.md
@@ -152,6 +152,26 @@ class ProductPage extends StatelessWidget {
 Routes.product.push(context, Product(id: 'item_id'));
 ```
 
+```dart
+@Routable(path: '/search', useQueryParams: true)
+class SearchPage extends StatelessWidget {
+  final Map<String, String>? queryParams;
+
+  SearchPage({this.queryParams});
+
+  ...
+}
+
+// Generated GoRoute for SearchPage
+GoRoute(
+  path: '/search',
+  pageBuilder: (context, state) => MaterialPage(
+    child: SearchPage(queryParams: state.uri.queryParameters),
+  ),
+),
+```
+
+
 ## Contributing
 
 Contributions are welcome! Please open an issue or submit a pull request.