+Update docs and add working example

- Add simple working example
- Simplify README documentation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Author: robelator

README.md

@@ -1,56 +1,53 @@
-<a href="https://www.buymeacoffee.com/dev_cetera" target="_blank"><img align="right" src="https://cdn.buymeacoffee.com/buttons/default-orange.png" height="48"></a>
-<a href="https://discord.gg/gEQ8y2nfyX" target="_blank"><img align="right" src="https://raw.githubusercontent.com/dev-cetera/.github/refs/heads/main/assets/icons/discord_icon/discord_icon.svg" height="48"></a>
+[![banner](https://github.com/dev-cetera/df_screen_core/blob/v0.5.7/doc/assets/banner.png?raw=true)](https://github.com/dev-cetera)
 
-Dart & Flutter Packages by dev-cetera.com & contributors.
-
-[![sponsor](https://img.shields.io/badge/sponsor-grey?logo=github-sponsors)](https://github.com/sponsors/dev-cetera)
-[![patreon](https://img.shields.io/badge/patreon-grey?logo=patreon)](https://www.patreon.com/c/RobertMollentze)
 [![pub](https://img.shields.io/pub/v/df_screen_core.svg)](https://pub.dev/packages/df_screen_core)
-[![tag](https://img.shields.io/badge/tag-v0.5.5-purple?logo=github)](https://github.com/dev-cetera/df_screen_core/tree/v0.5.5)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dev-cetera/df_screen_core/main/LICENSE)
+[![tag](https://img.shields.io/badge/Tag-v0.5.7-purple?logo=github)](https://github.com/dev-cetera/df_screen_core/tree/v0.5.7)
+[![buymeacoffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/dev_cetera)
+[![sponsor](https://img.shields.io/badge/Sponsor-grey?logo=github-sponsors&logoColor=pink)](https://github.com/sponsors/dev-cetera)
+[![patreon](https://img.shields.io/badge/Patreon-grey?logo=patreon)](https://www.patreon.com/robelator)
+[![discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/gEQ8y2nfyX)
+[![instagram](https://img.shields.io/badge/Instagram-E4405F?logo=instagram&logoColor=white)](https://www.instagram.com/dev_cetera/)
+[![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/dev-cetera/df_screen_core/main/LICENSE)
 
 ---
 
-[![banner](https://github.com/dev-cetera/df_safer_dart/blob/v0.5.5/doc/assets/banner.png?raw=true)](https://github.com/dev-cetera)
-
 <!-- BEGIN _README_CONTENT -->
 
 ## Summary
 
-A package that provides core code for the df_screen package.
+Core data models for the [df_screen](https://pub.dev/packages/df_screen) package.
 
-<!-- END _README_CONTENT -->
+## Usage
 
----
+```dart
+import 'package:df_screen_core/df_screen_core.dart';
 
-☝️ Please refer to the [API reference](https://pub.dev/documentation/df_screen_core/) for more information.
+final config = ModelScreenConfiguration(
+  path: '/home',
+  title: 'Home Screen',
+  isAccessibleOnlyIfLoggedIn: true,
+  args: {'userId': '123'},
+);
 
----
+print(config.path);  // /home
+print(config.arg<String>('userId'));  // 123
+```
 
-## 💬 Contributing and Discussions
+## Models
 
-This is an open-source project, and we warmly welcome contributions from everyone, regardless of experience level. Whether you're a seasoned developer or just starting out, contributing to this project is a fantastic way to learn, share your knowledge, and make a meaningful impact on the community.
+- `ModelScreenConfiguration` - Screen config with path, title, access control, and args
+- `ModelGenerateScreenBindings` - Code generation config for screen bindings
 
-### ☝️ Ways you can contribute
-
-- **Buy me a coffee:** If you'd like to support the project financially, consider [buying me a coffee](https://www.buymeacoffee.com/dev_cetera). Your support helps cover the costs of development and keeps the project growing.
-- **Find us on Discord:** Feel free to ask questions and engage with the community here: https://discord.gg/gEQ8y2nfyX.
-- **Share your ideas:** Every perspective matters, and your ideas can spark innovation.
-- **Help others:** Engage with other users by offering advice, solutions, or troubleshooting assistance.
-- **Report bugs:** Help us identify and fix issues to make the project more robust.
-- **Suggest improvements or new features:** Your ideas can help shape the future of the project.
-- **Help clarify documentation:** Good documentation is key to accessibility. You can make it easier for others to get started by improving or expanding our documentation.
-- **Write articles:** Share your knowledge by writing tutorials, guides, or blog posts about your experiences with the project. It's a great way to contribute and help others learn.
-
-No matter how you choose to contribute, your involvement is greatly appreciated and valued!
+<!-- END _README_CONTENT -->
 
-### ☕ We drink a lot of coffee...
+---
 
-If you're enjoying this package and find it valuable, consider showing your appreciation with a small donation. Every bit helps in supporting future development. You can donate here: https://www.buymeacoffee.com/dev_cetera
+For more details, see the [API reference](https://pub.dev/documentation/df_screen_core/).
 
-<a href="https://www.buymeacoffee.com/dev_cetera" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" height="40"></a>
+## Contributing
 
-## 🧑‍⚖️ License
+Join our [Discord](https://discord.gg/gEQ8y2nfyX) or support us on [Buy Me A Coffee](https://www.buymeacoffee.com/dev_cetera).
 
-This project is released under the [MIT License](https://raw.githubusercontent.com/dev-cetera/df_screen_core/main/LICENSE). See [LICENSE](https://raw.githubusercontent.com/dev-cetera/df_screen_core/main/LICENSE) for more information.
+## License
 
+[MIT License](https://raw.githubusercontent.com/dev-cetera/df_screen_core/main/LICENSE)

_README_CONTENT.md

@@ -1,3 +1,24 @@
 ## Summary
 
-A package that provides core code for the df_screen package.
+Core data models for the [df_screen](https://pub.dev/packages/df_screen) package.
+
+## Usage
+
+```dart
+import 'package:df_screen_core/df_screen_core.dart';
+
+final config = ModelScreenConfiguration(
+  path: '/home',
+  title: 'Home Screen',
+  isAccessibleOnlyIfLoggedIn: true,
+  args: {'userId': '123'},
+);
+
+print(config.path);  // /home
+print(config.arg<String>('userId'));  // 123
+```
+
+## Models
+
+- `ModelScreenConfiguration` - Screen config with path, title, access control, and args
+- `ModelGenerateScreenBindings` - Code generation config for screen bindings

analysis_options.yaml

@@ -1,15 +1,5 @@
-##.title
-## ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
-##
-## Copyright © dev-cetera.com & contributors.
-##
-## The use of this source code is governed by an MIT-style license described in
-## the LICENSE file located in this project's root directory.
-##
-## See: https://opensource.org/license/mit
-##
-## ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
-##.title~
+# For dev-cetera.com
+# Version: 1
 
 include: package:lints/recommended.yaml
 
@@ -31,6 +21,7 @@ linter:
     prefer_relative_imports: true
     prefer_single_quotes: true
     require_trailing_commas: true
+    unawaited_futures: true
     unnecessary_this: true
 
 analyzer:
@@ -42,21 +33,26 @@ analyzer:
     strict-raw-types: true
   exclude:
     - build/**
+    # - '**.g.dart'
 
   errors:
-    unused_label: ignore
     always_declare_return_types: error
     avoid_renaming_method_parameters: error
     avoid_type_to_string: error
+    close_sinks: error
+    collection_methods_unrelated_type: error
     depend_on_referenced_packages: error
     flutter_style_todos: error
     invalid_override_of_non_virtual_member: error
     invalid_use_of_protected_member: error
+    missing_return: error
     no_leading_underscores_for_local_identifiers: error
     prefer_final_in_for_each: error
     prefer_relative_imports: error
+    record_literal_one_positional_no_trailing_comma: error
     unnecessary_new: error
     unrelated_type_equality_checks: error
+    unused_label: ignore
     use_key_in_widget_constructors: error
 
 formatter:

example/example.dart

@@ -1 +1,19 @@
-// Unavailable. Please check in later.
+import 'package:df_screen_core/df_screen_core.dart';
+
+void main() {
+  // Create a screen configuration.
+  final config = const ModelScreenConfiguration(
+    path: '/home',
+    title: 'Home Screen',
+    isAccessibleOnlyIfLoggedIn: true,
+    args: {'userId': '123'},
+  );
+
+  print('Path: ${config.path}');
+  print('Title: ${config.title}');
+  print('User ID: ${config.arg<String>('userId')}');
+
+  // Create config from current URL.
+  final currentConfig = currentBaseConfiguration();
+  print('Current path: ${currentConfig.path}');
+}

lib/src/data_models/model_generate_screen_bindings/_model_generate_screen_bindings.g.dart

@@ -244,10 +244,8 @@ class ModelGenerateScreenBindings extends _ModelGenerateScreenBindings {
       final title = json?['title']?.toString().trim().nullIfEmpty;
       final className = json?['className']?.toString().trim().nullIfEmpty;
       final screenKey = json?['screenKey']?.toString().trim().nullIfEmpty;
-      final keyStringCase = json?['keyStringCase']
-          ?.toString()
-          .trim()
-          .nullIfEmpty;
+      final keyStringCase =
+          json?['keyStringCase']?.toString().trim().nullIfEmpty;
       return ModelGenerateScreenBindings(
         args: args,
         isAccessibleOnlyIfLoggedInAndVerified:
@@ -298,26 +296,18 @@ class ModelGenerateScreenBindings extends _ModelGenerateScreenBindings {
   @override
   Map<String, dynamic> toJson({bool includeNulls = false}) {
     try {
-      final args0 = args
-          ?.map((p0, p1) => MapEntry(p0, p1))
-          .nonNulls
-          .nullIfEmpty;
+      final args0 =
+          args?.map((p0, p1) => MapEntry(p0, p1)).nonNulls.nullIfEmpty;
       final isAccessibleOnlyIfLoggedInAndVerified0 =
           isAccessibleOnlyIfLoggedInAndVerified;
       final isAccessibleOnlyIfLoggedIn0 = isAccessibleOnlyIfLoggedIn;
       final isAccessibleOnlyIfLoggedOut0 = isAccessibleOnlyIfLoggedOut;
       final isRedirectable0 = isRedirectable;
       final path0 = path?.trim().nullIfEmpty;
-      final queryParameters0 = queryParameters
-          ?.map((p0) => p0)
-          .nonNulls
-          .nullIfEmpty
-          ?.toList();
-      final internalParameters0 = internalParameters
-          ?.map((p0) => p0)
-          .nonNulls
-          .nullIfEmpty
-          ?.toList();
+      final queryParameters0 =
+          queryParameters?.map((p0) => p0).nonNulls.nullIfEmpty?.toList();
+      final internalParameters0 =
+          internalParameters?.map((p0) => p0).nonNulls.nullIfEmpty?.toList();
       final title0 = title?.trim().nullIfEmpty;
       final className0 = className?.trim().nullIfEmpty;
       final screenKey0 = screenKey?.trim().nullIfEmpty;
@@ -491,7 +481,7 @@ extension ModelGenerateScreenBindingsX on ModelGenerateScreenBindings {
       args: args ?? this.args,
       isAccessibleOnlyIfLoggedInAndVerified:
           isAccessibleOnlyIfLoggedInAndVerified ??
-          this.isAccessibleOnlyIfLoggedInAndVerified,
+              this.isAccessibleOnlyIfLoggedInAndVerified,
       isAccessibleOnlyIfLoggedIn:
           isAccessibleOnlyIfLoggedIn ?? this.isAccessibleOnlyIfLoggedIn,
       isAccessibleOnlyIfLoggedOut:
@@ -526,14 +516,12 @@ extension ModelGenerateScreenBindingsX on ModelGenerateScreenBindings {
       args: args ? this.args : null,
       isAccessibleOnlyIfLoggedInAndVerified:
           isAccessibleOnlyIfLoggedInAndVerified
-          ? this.isAccessibleOnlyIfLoggedInAndVerified
-          : null,
-      isAccessibleOnlyIfLoggedIn: isAccessibleOnlyIfLoggedIn
-          ? this.isAccessibleOnlyIfLoggedIn
-          : null,
-      isAccessibleOnlyIfLoggedOut: isAccessibleOnlyIfLoggedOut
-          ? this.isAccessibleOnlyIfLoggedOut
-          : null,
+              ? this.isAccessibleOnlyIfLoggedInAndVerified
+              : null,
+      isAccessibleOnlyIfLoggedIn:
+          isAccessibleOnlyIfLoggedIn ? this.isAccessibleOnlyIfLoggedIn : null,
+      isAccessibleOnlyIfLoggedOut:
+          isAccessibleOnlyIfLoggedOut ? this.isAccessibleOnlyIfLoggedOut : null,
       isRedirectable: isRedirectable ? this.isRedirectable : null,
       path: path ? this.path : null,
       queryParameters: queryParameters ? this.queryParameters : null,

lib/src/data_models/model_generate_screen_bindings/model_generate_screen_bindings.dart

@@ -48,7 +48,8 @@ part '_model_generate_screen_bindings.g.dart';
       fieldPath: ['isRedirectable'],
       fieldType: bool,
       nullable: true,
-      description: 'Enables URL redirection to this screen. If false, URL redirection is disabled.',
+      description:
+          'Enables URL redirection to this screen. If false, URL redirection is disabled.',
     ),
     Field(
       fieldPath: ['path'],
@@ -90,7 +91,8 @@ part '_model_generate_screen_bindings.g.dart';
       fieldPath: ['keyStringCase'],
       fieldType: String,
       nullable: true,
-      description: 'The string case for the keys of query and internal parameters.',
+      description:
+          'The string case for the keys of query and internal parameters.',
     ),
   },
 )

lib/src/data_models/model_screen_configuration/_model_screen_configuration.g.dart

@@ -254,10 +254,8 @@ class ModelScreenConfiguration extends _ModelScreenConfiguration {
   @override
   Map<String, dynamic> toJson({bool includeNulls = false}) {
     try {
-      final args0 = args
-          ?.map((p0, p1) => MapEntry(p0, p1))
-          .nonNulls
-          .nullIfEmpty;
+      final args0 =
+          args?.map((p0, p1) => MapEntry(p0, p1)).nonNulls.nullIfEmpty;
       final isAccessibleOnlyIfLoggedInAndVerified0 =
           isAccessibleOnlyIfLoggedInAndVerified;
       final isAccessibleOnlyIfLoggedIn0 = isAccessibleOnlyIfLoggedIn;
@@ -391,7 +389,7 @@ extension ModelScreenConfigurationX on ModelScreenConfiguration {
       args: args ?? this.args,
       isAccessibleOnlyIfLoggedInAndVerified:
           isAccessibleOnlyIfLoggedInAndVerified ??
-          this.isAccessibleOnlyIfLoggedInAndVerified,
+              this.isAccessibleOnlyIfLoggedInAndVerified,
       isAccessibleOnlyIfLoggedIn:
           isAccessibleOnlyIfLoggedIn ?? this.isAccessibleOnlyIfLoggedIn,
       isAccessibleOnlyIfLoggedOut:
@@ -418,14 +416,12 @@ extension ModelScreenConfigurationX on ModelScreenConfiguration {
       args: args ? this.args : null,
       isAccessibleOnlyIfLoggedInAndVerified:
           isAccessibleOnlyIfLoggedInAndVerified
-          ? this.isAccessibleOnlyIfLoggedInAndVerified
-          : null,
-      isAccessibleOnlyIfLoggedIn: isAccessibleOnlyIfLoggedIn
-          ? this.isAccessibleOnlyIfLoggedIn
-          : null,
-      isAccessibleOnlyIfLoggedOut: isAccessibleOnlyIfLoggedOut
-          ? this.isAccessibleOnlyIfLoggedOut
-          : null,
+              ? this.isAccessibleOnlyIfLoggedInAndVerified
+              : null,
+      isAccessibleOnlyIfLoggedIn:
+          isAccessibleOnlyIfLoggedIn ? this.isAccessibleOnlyIfLoggedIn : null,
+      isAccessibleOnlyIfLoggedOut:
+          isAccessibleOnlyIfLoggedOut ? this.isAccessibleOnlyIfLoggedOut : null,
       isRedirectable: isRedirectable ? this.isRedirectable : null,
       path: path ? this.path : null,
       prevConfiguration: prevConfiguration ? this.prevConfiguration : null,

lib/src/data_models/model_screen_configuration/model_screen_configuration.dart

@@ -107,7 +107,8 @@ ModelScreenConfiguration urlToScreenConfiguration({
   return ModelScreenConfiguration(
     args: args,
     isAccessibleOnlyIfLoggedIn: isAccessibleOnlyIfLoggedIn,
-    isAccessibleOnlyIfLoggedInAndVerified: isAccessibleOnlyIfLoggedInAndVerified,
+    isAccessibleOnlyIfLoggedInAndVerified:
+        isAccessibleOnlyIfLoggedInAndVerified,
     isAccessibleOnlyIfLoggedOut: isAccessibleOnlyIfLoggedOut,
     isRedirectable: isRedirectable,
     path: path,

pubspec.yaml

@@ -13,13 +13,15 @@
 
 name: df_screen_core
 homepage: https://dev-cetera.com/
-repository: https://github.com/robmllze/df_screen_core
 funding:
 - https://www.buymeacoffee.com/dev_cetera
-- https://www.patreon.com/c/RobertMollentze
-- https://github.com/sponsors/robmllze
+- https://www.patreon.com/c/robelator
+- https://github.com/sponsors/robelator
+- https://www.patreon.com/c/robelator
+- https://github.com/sponsors/robelator
+- https://www.buymeacoffee.com/dev_cetera
 description: A package that provides core code for the df_screen package.
-version: 0.5.5
+version: 0.5.7
 topics:
   - user-interface
   - widgets
@@ -35,7 +37,7 @@ environment:
 ## -----------------------------------------------------------------------------
 
 dependencies:
-  df_generate_dart_models_core: ^0.9.22
+  df_generate_dart_models_core: ^0.9.23
   df_log: ^0.3.20
 
 ## -----------------------------------------------------------------------------