NiceCookieConsent class

GDPR-compliant cookie consent banner with category toggles.

NiceCookieConsent(
  visible: true,
  categories: [
    NiceCookieCategory(type: NiceCookieCategoryType.necessary, title: 'Necessary', description: 'Required', required: true),
    NiceCookieCategory(type: NiceCookieCategoryType.analytics, title: 'Analytics', description: 'Usage data'),
  ],
  onSave: (consents) => print(consents),
)
Inheritance
Available extensions

Constructors

NiceCookieConsent({Key? key, bool visible = true, List<NiceCookieCategory> categories = const [], Map<NiceCookieCategoryType, bool> defaults = const {}, NiceCookieConsentPosition position = NiceCookieConsentPosition.bottom, String? policyUrl, bool showDetails = false, String? title, String? message, String? acceptAllLabel, String? rejectAllLabel, String? saveLabel, String? settingsLabel, VoidCallback? onAcceptAll, VoidCallback? onRejectAll, void onSave(Map<NiceCookieCategoryType, bool> consents)?})
const

Properties

acceptAllLabel → String?
final
categories → List<NiceCookieCategory>
final
defaults → Map<NiceCookieCategoryType, bool>
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message → String?
final
onAcceptAll → VoidCallback?
final
onRejectAll → VoidCallback?
final
onSave → void Function(Map<NiceCookieCategoryType, bool> consents)?
final
policyUrl → String?
final
position → NiceCookieConsentPosition
final
rejectAllLabel → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saveLabel → String?
final
settingsLabel → String?
final
showDetails → bool
final
title → String?
final
visible → bool
final

Methods

asFocusable({FocusNode? focusNode, bool autofocus = false}) → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as focusable.
asSemanticButton({String? label, VoidCallback? onTap}) → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a button for screen readers.
asSemanticHeading(String label) → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a heading for screen readers.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<NiceCookieConsent>
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
excludeFromSemantics() → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Exclude this widget from the semantic tree.
mergeSemantics() → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Merge semantics of child widgets.
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
withSemanticLabel(String label) → Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Add a semantic label to this widget.

Operators

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