flex pane notifier

flex_pane_notifier.dart

// Copyright 2025 Fredrick Allan Grott. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.


import 'package:flutter/material.dart';
import 'package:userinterface/core/widgets/canonical_layout_models.dart';

/// FlexPaneNotitier is to pass the FlexPaneModel view-model 
/// as an observer into the two pane canonical layout.
///
/// Generally as
/// ```dart
/// return FlexPaneNotifier(
///   notifier: FlexPaneModel,
///   child: Builder(builder: (BuildContext context){
///             return Containr()
/// ```
/// 
/// For both the Axis direction value and the seam rect value
/// the reference used will be:
/// ```dart
///  FlexPaneNotifier.of(context).appDirection;
///
///  FlexPaneNotifier.of(context).appSeamRect;
/// ```
///
/// @author Fredrick Allan Grott
class FlexPaneNotifier extends InheritedNotifier<FlexPaneModel> {
  const FlexPaneNotifier({
    super.key,
    super.notifier,
    required super.child,
  });



  static FlexPaneModel? of(BuildContext context){
    return context.dependOnInheritedWidgetOfExactType<FlexPaneNotifier>()!.notifier;
  }


  @override
  bool updateShouldNotify(FlexPaneNotifier oldState) {
    return true;
  }

}