Class ScaffoldState | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScaffoldState

    Inheritance
    System.Object
    Diagnosticable
    State
    State<Scaffold>
    TickerProviderStateMixin<Scaffold>
    ScaffoldState
    Inherited Members
    TickerProviderStateMixin<Scaffold>.createTicker(TickerCallback)
    TickerProviderStateMixin<Scaffold>.debugFillProperties(DiagnosticPropertiesBuilder)
    State<Scaffold>.widget
    State<Scaffold>._debugTypesAreRight(Widget)
    State.context
    State.mounted
    State.setState(VoidCallback)
    State.deactivate()
    Diagnosticable.toStringShort()
    Diagnosticable.ToString()
    Diagnosticable.toString(DiagnosticLevel)
    Diagnosticable.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    Namespace: Unity.UIWidgets.material
    Syntax
    public class ScaffoldState : TickerProviderStateMixin<Scaffold>, TickerProvider

    Fields

    _drawerKey

    Declaration
    public readonly GlobalKey<DrawerControllerState> _drawerKey
    Field Value
    Type Description
    GlobalKey<DrawerControllerState>

    _endDrawerKey

    Declaration
    public readonly GlobalKey<DrawerControllerState> _endDrawerKey
    Field Value
    Type Description
    GlobalKey<DrawerControllerState>

    Properties

    hasDrawer

    Declaration
    public bool hasDrawer { get; }
    Property Value
    Type Description
    System.Boolean

    hasEndDrawer

    Declaration
    public bool hasEndDrawer { get; }
    Property Value
    Type Description
    System.Boolean

    isDrawerOpen

    Declaration
    public bool isDrawerOpen { get; }
    Property Value
    Type Description
    System.Boolean

    isEndDrawerOpen

    Declaration
    public bool isEndDrawerOpen { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    build(BuildContext)

    Declaration
    public override Widget build(BuildContext context)
    Parameters
    Type Name Description
    BuildContext context
    Returns
    Type Description
    Widget
    Overrides
    State.build(BuildContext)

    didChangeDependencies()

    Declaration
    public override void didChangeDependencies()
    Overrides
    Unity.UIWidgets.widgets.TickerProviderStateMixin<Unity.UIWidgets.material.Scaffold>.didChangeDependencies()

    didUpdateWidget(StatefulWidget)

    Declaration
    public override void didUpdateWidget(StatefulWidget oldWidget)
    Parameters
    Type Name Description
    StatefulWidget oldWidget
    Overrides
    State.didUpdateWidget(StatefulWidget)

    dispose()

    Declaration
    public override void dispose()
    Overrides
    Unity.UIWidgets.widgets.TickerProviderStateMixin<Unity.UIWidgets.material.Scaffold>.dispose()

    hideCurrentSnackBar(SnackBarClosedReason)

    Declaration
    public void hideCurrentSnackBar(SnackBarClosedReason reason = SnackBarClosedReason.hide)
    Parameters
    Type Name Description
    SnackBarClosedReason reason

    initState()

    Declaration
    public override void initState()
    Overrides
    State.initState()

    openDrawer()

    Declaration
    public void openDrawer()

    openEndDrawer()

    Declaration
    public void openEndDrawer()

    removeCurrentSnackBar(SnackBarClosedReason)

    Declaration
    public void removeCurrentSnackBar(SnackBarClosedReason reason = SnackBarClosedReason.remove)
    Parameters
    Type Name Description
    SnackBarClosedReason reason

    showBottomSheet(WidgetBuilder)

    Declaration
    public PersistentBottomSheetController<object> showBottomSheet(WidgetBuilder builder)
    Parameters
    Type Name Description
    WidgetBuilder builder
    Returns
    Type Description
    PersistentBottomSheetController<System.Object>

    showSnackBar(SnackBar)

    Declaration
    public ScaffoldFeatureController<SnackBar, SnackBarClosedReason> showSnackBar(SnackBar snackbar)
    Parameters
    Type Name Description
    SnackBar snackbar
    Returns
    Type Description
    ScaffoldFeatureController<SnackBar, SnackBarClosedReason>
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023