OudsTheme class
OudsTheme is an InheritedWidget that provides a way to share the Ouds theme configuration (colors, typography, etc.) and the current theme mode (light or dark) across the widget tree. It replaces the default MaterialTheme in Flutter. Use it at the root of your application to apply the theme to your entire app or specific parts of the widget tree.
- Inheritance
Constructors
- OudsTheme({Key? key, required OudsThemeContract themeContract, required ThemeMode themeMode, required bool onColoredSurface, required Widget child})
- Constructor to initialize the OudsTheme with a theme configuration and theme mode. @param themeContract The theme configuration containing colors, typography, etc. @param themeMode The current theme mode (light or dark). @param onColoredSurface Whether the theme is applied on a colored surface. @param child The widget tree that will be wrapped by this theme.
Properties
- child → Widget
-
The widget below this widget in the tree.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onColoredSurface → bool
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- themeContract → OudsThemeContract
-
final
- themeMode → ThemeMode
-
final
Methods
-
createElement(
) → InheritedModelElement< OudsThemeAspect> -
Inflates this configuration to a concrete instance.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
isSupportedAspect(
Object aspect) → bool -
Returns true if this model supports the given
aspect.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
-
updateShouldNotify(
covariant InheritedModel< OudsThemeAspect> oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
-
updateShouldNotifyDependent(
covariant InheritedModel< OudsThemeAspect> oldWidget, Set<OudsThemeAspect> dependencies) → bool -
Return true if the changes between this model and
oldWidgetmatch any of thedependencies.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- themeModeGlobal → ThemeMode
-
no setter
Static Methods
-
isOnColoredSurfaceOf(
BuildContext context) → bool - Retrieves the bool from the widget tree. This allows access to the current isOnColoredSurfaceOf @param context The BuildContext from which to retrieve the theme. @returns The bool associated with the current context.
-
modeOf(
BuildContext context) → ThemeMode? - Retrieves the ThemeMode from the widget tree. This allows access to the current theme mode (light or dark).. @param context The BuildContext from which to retrieve the theme. @returns The ThemeMode associated with the current context.
-
of(
BuildContext context) → OudsThemeContract - Retrieves the OudsThemeContract from the widget tree. This allows access to the theme configuration (colors, typography, etc.). @param context The BuildContext from which to retrieve the theme. @returns The OudsThemeContract associated with the current context.