S2ModalConfig class

Modal configuration

Mixed-in types

• Diagnosticable

Annotations

• @immutable

Constructors

S2ModalConfig({S2ModalTypetype =S2ModalType.fullPage,Stringtitle,booluseHeader =true,booluseConfirm =false,IconconfirmIcon,WidgetconfirmLabel,ColorconfirmColor,EdgeInsetsGeometryconfirmMargin,BrightnessconfirmBrightness =Brightness.light,booluseFilter =false,boolfilterAuto =false,DurationfilterDelay =const Duration(milliseconds: 300),StringfilterHint,doublemaxHeightFactor =0.6,boolenableDrag =true,boolbarrierDismissible =true,ColorbarrierColor,S2ModalStylestyle =const S2ModalStyle(),S2ModalHeaderStyleheaderStyle =const S2ModalHeaderStyle()})

Create modal configuration

const

Properties

barrierColor→Color

ThebarrierColor argument is used to specify the color of the modalbarrier that darkens everything the dialog. Ifnull the default colorColors.black54 is used.

final

barrierDismissible→bool

ThebarrierDismissible argument is used to indicate whether tapping on thebarrier will dismiss the dialog. It istrue by default and can not benull.

final

confirmBrightness→Brightness

custom confirmation brightness

final

confirmColor→Color

custom confirmation color

final

confirmIcon→Icon

custom confirmation icon

final

confirmIsDark→bool

Returns true if the confirm button brightness is dark

no setter

confirmIsLight→bool

Returns true if the confirm button brightness is light

no setter

confirmLabel→Widget

custom confirmation label

final

confirmMargin→EdgeInsetsGeometry

custom confirmation padding

final

enableDrag→bool

Iftype isS2ModalType.bottomSheet, specifies whether the bottom sheet can be dragged up and down and dismissed by swiping downwards.

final

filterAuto→bool

Whether the filter is autocomplete or need confirmation

final

filterDelay→Duration

The filter autocomplete delay

final

filterHint→String

Custom searchbar hint

final

hashCode→int

The hash code for this object.

no setterinherited

headerStyle→S2ModalHeaderStyle

Configure modal header style

final

isBottomSheet→bool

Returns true if the modal type is bottom sheet

no setter

isFullPage→bool

Returns true if the modal type is full page

no setter

isPopupDialog→bool

Returns true if the modal type is popup dialog

no setter

maxHeightFactor→double

Iftype isS2ModalType.bottomSheet, specifies the max height factor, the value must be between0 and 1

final

runtimeType→Type

A representation of the runtime type of the object.

no setterinherited

style→S2ModalStyle

Configure modal style

final

title→String

Use different title with the trigger widget title

final

type→S2ModalType

Modal type to display choices

final

useConfirm→bool

Whether the option list need to confirmto return the changed value

final

useFilter→bool

Whether the option list is filterable or not

final

useHeader→bool

Whether the options list modal use header or not

final

Methods

copyWith({S2ModalTypetype,Stringtitle,booluseHeader,booluseConfirm,IconconfirmIcon,WidgetconfirmLabel,ColorconfirmColor,EdgeInsetsGeometryconfirmMargin,BrightnessconfirmBrightness,booluseFilter,boolfilterAuto,DurationfilterDelay,StringfilterHint,doublemaxHeightFactor,boolenableDrag,boolbarrierDismissible,ColorbarrierColor,S2ModalStylestyle,S2ModalHeaderStyleheaderStyle})→S2ModalConfig

Creates a copy of thisS2ModalConfig but withthe given fields replaced with the new values.

debugFillProperties(DiagnosticPropertiesBuilderproperties)→ void

Add additional properties associated with the node.

inherited

merge(S2ModalConfigother)→S2ModalConfig

Returns a newS2ModalConfig that isa combination of this object and the givenother style.

noSuchMethod(Invocationinvocation)→ 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 debuggingtools and byDiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevelminLevel =DiagnosticLevel.info})→String

A string representation of this object.

inherited

toStringShort()→String

A brief description of this object, usually just theruntimeType and thehashCode.

inherited

Operators

operator ==(Objectother)→bool

The equality operator.

inherited