PermissionGuard class

Guardian widget, that assures that given permission is granted or sufficient.

You can pass PermissionGuardOptions to customize the the.

PermissionGuard uses Theme.of(context) everywhere possible. If you want to customize just colors or text appearance, try to play around with ThemeData like so:

Theme(
  data: Theme.of(context).copyWith(
    primaryTextTheme: const TextTheme(
      headlineMedium: TextStyle(fontSize: 30),
      bodyMedium: TextStyle(fontSize: 14),
    ),
    colorScheme: Theme.of(context).colorScheme.copyWith(
          primary: Colors.red,
        ),
  ),
  child: const PermissionGuard(
    permission: Permission.camera,
    child: _PermissionGrantedBody(),
  ),
),
Inheritance

Constructors

PermissionGuard({Key? key, required Permission permission, required Widget child, PermissionGuardOptions options = const PermissionGuardOptions(), void onPermissionStatusChanged(PermissionStatus status)?, VoidCallback? onPermissionGranted})
Default constructor for PermissionGuard.
const

Properties

child → Widget
Widget that should be displayed when permission status is PermissionStatus.granted.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onPermissionGranted → VoidCallback?
Callback for reacting to permission granted.
final
onPermissionStatusChanged → (void Function(PermissionStatus status)?)
Returns the new PermissionStatus whenever it's changed.
final
options → PermissionGuardOptions
Customization options, see PermissionGuardOptions for default values.
final
permission → Permission
Permission that requires guarding.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PermissionGuard>
Creates the mutable state for this widget at a given location in the tree.
override
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
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}) → 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

Operators

operator ==(Object other) → bool
The equality operator.
inherited