mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +00:00
docs(provider): add detailed English API documentation for CherryPickProvider Flutter integration
- Replaced all comments with complete DartDoc in English for CherryPickProvider - Documented all methods (constructor, of, openRootScope, openSubScope, updateShouldNotify) - Added code samples for typical Flutter+CherryPick integration, root and subscope usage - Makes Flutter DI integration intuitive for new users and improves IDE support - No logic or API changes, documentation only
This commit is contained in:
@@ -14,29 +14,87 @@ import 'package:flutter/widgets.dart';
|
|||||||
/// limitations under the License.
|
/// limitations under the License.
|
||||||
///
|
///
|
||||||
|
|
||||||
|
/// {@template cherrypick_flutter_provider}
|
||||||
|
/// An [InheritedWidget] that provides convenient integration of CherryPick
|
||||||
|
/// dependency injection scopes into the Flutter widget tree.
|
||||||
|
///
|
||||||
|
/// Place `CherryPickProvider` at the top of your widget subtree to make a
|
||||||
|
/// [Scope] (or its descendants) available via `CherryPickProvider.of(context)`.
|
||||||
|
///
|
||||||
|
/// This is the recommended entry point for connecting CherryPick DI to your
|
||||||
|
/// Flutter app or feature area, enabling context-based scope management and
|
||||||
|
/// DI resolution in child widgets.
|
||||||
|
///
|
||||||
|
/// ### Example: Root Integration
|
||||||
|
/// ```dart
|
||||||
|
/// void main() {
|
||||||
|
/// final rootScope = CherryPick.openRootScope()
|
||||||
|
/// ..installModules([AppModule()]);
|
||||||
|
/// runApp(
|
||||||
|
/// CherryPickProvider(
|
||||||
|
/// child: MyApp(),
|
||||||
|
/// ),
|
||||||
|
/// );
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// // In any widget:
|
||||||
|
/// final provider = CherryPickProvider.of(context);
|
||||||
|
/// final scope = provider.openRootScope();
|
||||||
|
/// final myService = scope.resolve<MyService>();
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// ### Example: Subscope for a Feature/Screen
|
||||||
|
/// ```dart
|
||||||
|
/// Widget build(BuildContext context) {
|
||||||
|
/// final provider = CherryPickProvider.of(context);
|
||||||
|
/// final featureScope = provider.openSubScope(scopeName: 'featureA');
|
||||||
|
/// return MyFeatureScreen(scope: featureScope);
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// You can use [openRootScope] and [openSubScope] as helpers to get/create scopes.
|
||||||
|
/// {@endtemplate}
|
||||||
final class CherryPickProvider extends InheritedWidget {
|
final class CherryPickProvider extends InheritedWidget {
|
||||||
|
/// Opens (or returns) the application-wide root [Scope].
|
||||||
|
///
|
||||||
|
/// Use to make all dependencies available at the top of your widget tree.
|
||||||
Scope openRootScope() => CherryPick.openRootScope();
|
Scope openRootScope() => CherryPick.openRootScope();
|
||||||
|
|
||||||
|
/// Opens a subscope (child [Scope]) with the given [scopeName].
|
||||||
|
///
|
||||||
|
/// Useful to create isolated feature/module scopes in widget subtrees.
|
||||||
|
/// If [scopeName] is empty, an unnamed scope is created.
|
||||||
Scope openSubScope({String scopeName = '', String separator = '.'}) =>
|
Scope openSubScope({String scopeName = '', String separator = '.'}) =>
|
||||||
CherryPick.openScope(scopeName: scopeName, separator: separator);
|
CherryPick.openScope(scopeName: scopeName, separator: separator);
|
||||||
|
|
||||||
// Constructor for CherryPickProvider. Initializes with a required rootScope and child widget.
|
/// Creates a [CherryPickProvider] and exposes it to the widget subtree.
|
||||||
|
///
|
||||||
|
/// Place near the root of your widget tree. Use [child] to provide the subtree.
|
||||||
const CherryPickProvider({
|
const CherryPickProvider({
|
||||||
super.key,
|
super.key,
|
||||||
required super.child,
|
required super.child,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Method to access the nearest CherryPickProvider instance from the context
|
/// Locates the nearest [CherryPickProvider] up the widget tree from [context].
|
||||||
|
///
|
||||||
|
/// Throws if not found. Use this to access DI [Scope] controls anywhere below the provider.
|
||||||
|
///
|
||||||
|
/// Example:
|
||||||
|
/// ```dart
|
||||||
|
/// final provider = CherryPickProvider.of(context);
|
||||||
|
/// final scope = provider.openRootScope();
|
||||||
|
/// ```
|
||||||
static CherryPickProvider of(BuildContext context) {
|
static CherryPickProvider of(BuildContext context) {
|
||||||
// Looks up the widget tree for an instance of CherryPickProvider
|
|
||||||
final CherryPickProvider? result =
|
final CherryPickProvider? result =
|
||||||
context.dependOnInheritedWidgetOfExactType<CherryPickProvider>();
|
context.dependOnInheritedWidgetOfExactType<CherryPickProvider>();
|
||||||
// Assert to ensure a CherryPickProvider is present in the context
|
|
||||||
assert(result != null, 'No CherryPickProvider found in context');
|
assert(result != null, 'No CherryPickProvider found in context');
|
||||||
return result!;
|
return result!;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determines whether the widget should notify dependents when it changes
|
/// Controls update notifications for dependent widgets.
|
||||||
|
///
|
||||||
|
/// Always returns false because the provider itself is stateless:
|
||||||
|
/// changes are to the underlying scopes, not the widget.
|
||||||
@override
|
@override
|
||||||
bool updateShouldNotify(CherryPickProvider oldWidget) {
|
bool updateShouldNotify(CherryPickProvider oldWidget) {
|
||||||
return false;
|
return false;
|
||||||
|
|||||||
Reference in New Issue
Block a user