sbb_design_system_mobile library

Classes

SBBAccentButton
The accent variant of the SBB Button.
SBBAccentButtonThemeData
The ThemeData for the SBBAccentButton.
SBBAutocompletion<T>
SBB Autocompletion, BETA!
SBBAutocompletionState<T>
SBBBaseStyle
Base style used in SBBTheme.
SBBBottomSheet
The SBB Bottom Sheet widget.
SBBBottomSheetConfig
Configuration for parameters of showSBBBottomSheet.
SBBBottomSheetStyle
Defines the visual properties of SBBBottomSheet.
SBBBottomSheetThemeData
The ThemeData for SBBBottomSheet.
SBBButtonSegment<T>
Describes the data for a segment in an SBBSegmentedButton.
SBBButtonSegmentStyle
Defines the visual properties for an SBBButtonSegment.
SBBButtonStyle
Style for SBB Buttons. Use this in combination with SBBButtonThemeData to override all button variants within the current SBBTheme.
SBBCascadeColumn
A widget that accomplishes the cascading shrink effect of the SBBSliverHeaderBox.
SBBCheckbox
The SBB Checkbox.
SBBCheckboxListItem
A convenience wrapper that combines SBBListItem with SBBCheckbox as the leading widget.
SBBCheckboxListItemBoxed
A boxed variant of SBBCheckboxListItem with rounded borders.
SBBCheckboxStyle
Defines the visual properties of SBBCheckbox.
SBBCheckboxThemeData
The ThemeData for the SBBCheckbox.
SBBChip
The SBB Chip.
SBBChipStyle
Defines the visual properties of SBBChip.
SBBChipThemeData
The ThemeData for the SBBChip.
SBBColors
The colors as defined in https://www.figma.com/design/5j2eZ2D0sHYFKkRSmFdBPJ/SBB-Colors and https://digital.sbb.ch/de/foundation/colors/base-colors/
SBBColorScheme
Defines the base color scheme used by the SBB design system. Used by components to set their default color values.
SBBContentBox
SBBContentBox. Use to structure content.
SBBContentBoxStyle
Defines the visual properties of SBBContentBox.
SBBContentBoxThemeData
The ThemeData for the SBBContentBox.
SBBContractible
A widget that changes its visible height as its parent contracts during scroll.
SBBContractibleCrossfade
A widget that crossfades between two children as a header contracts.
SBBContractibleState
Represents the current state of expansion (and contraction) in the context of a SBBContractible and its parent SBBCascadeColumn.
SBBContractionListener
A widget that listens to expansion state changes.
SBBContractionState
Represents the current state of expansion (and contraction) of a SBBCascadeColumn.
SBBDateInput
This is basically a convenience combination of a SBBDecoratedText and a SBBDatePicker.
SBBDatePicker
SBB Date Picker. Use according to documentation.
SBBDatePickerController
A controller for SBBDatePicker that allows programmatically setting the selected date, e.g. from instrumentation tests.
SBBDateTimeInput
This is basically a convenience combination of a SBBDecoratedText and a SBBDateTimePicker.
SBBDateTimePicker
SBB Date Time Picker. Use according to documentation.
SBBDateTimePickerController
A controller for SBBDateTimePicker that allows programmatically setting the selected date time, e.g. from instrumentation tests.
SBBDecorated
The SBB Decorated.
SBBDecoratedBoxed
The boxed variant of SBBDecorated.
SBBDecoratedStyle
Defines the visual properties of SBBDecorated.
SBBDecoratedText
The SBB Decorated Text.
SBBDecoratedTextBoxed
The boxed variant of SBBDecoratedText.
SBBDecoratedTextConfig
Configuration for the layout and focus related fields of SBBDecoratedText.
SBBDecoratedTextStyle
Defines the visual properties of SBBDecoratedText.
SBBDecoratedTextThemeData
The theme data for SBBDecoratedText.
SBBDecoratedThemeData
The theme data for SBBDecorated.
SBBDivider
A one-pixel divider line using the SBB design system styling.
SBBDropdown<T>
The SBB Dropdown.
SBBDropdownItem<T>
An item in a menu created by a SBBDropdown or SBBMultiDropdown.
SBBDropdownThemeData
The theme data for SBBDropdown and SBBMultiDropdown.
SBBFontFamily
Provides constants for all font families defined in the SBB design system mobile.
SBBHeader
The SBB Header.
SBBHeaderBox
The SBB Header-Box.
SBBHeaderBoxFlap
The default flap content for a SBB Header-Box.
SBBHeaderBoxFlapPreferredSize
The default flap content for a SBB Header-Box with a preferred size.
SBBHeaderBoxFlapStyle
Defines the visual properties of SBBHeaderBoxFlap.
SBBHeaderBoxLarge
The SBB Header-Box in its large variant.
SBBHeaderBoxPreferredSize
The SBB Header-Box with a predictable size.
SBBHeaderBoxStyle
Defines the visual properties of SBBHeaderBox.
SBBHeaderBoxThemeData
Theme data for the SBBHeaderBox.
SBBHeaderLeadingBackButton
An SBB-styled "back" leading button for use in SBBHeader.
SBBHeaderLeadingCloseButton
An SBB-styled "close" leading button for use in SBBHeader.
SBBHeaderLeadingMenuButton
An SBB-styled "menu" leading button for use in SBBHeader.
SBBHeaderSmall
The small variant of SBB Header
SBBHeaderStyle
Defines the visual properties of SBBHeader.
SBBHeaderThemeData
The ThemeData for the SBBHeader.
SBBIcons
SBBIconsIndex
SBBIllustration
SBBInputDecoration
Defines the visual properties and content for SBB inputs.
SBBInputDecorationThemeData
The ThemeData for the SBBInputDecoration.
SBBLinearLoadingIndicator
The SBB Linear Loading Indicator.
SBBLinearLoadingIndicatorStyle
Defines the visual properties of SBBLinearLoadingIndicator.
SBBLinearLoadingIndicatorThemeData
The ThemeData for SBBLinearLoadingIndicator.
SBBListHeader
The SBB List Header.
SBBListHeaderStyle
Defines the visual properties of SBBListHeader.
SBBListHeaderThemeData
The ThemeData for the SBBListHeader.
SBBListItem
A customizable list item component following the SBB design system.
SBBListItemBoxed
The boxed variant of SBBListItem.
SBBListItemStyle
Defines the visual properties of SBBListItem.
SBBListItemThemeData
The ThemeData for the SBBListItem.
SBBLoadingIndicator
The SBB LoadingIndicator. Use according to documentation.
The SBB Logo also known as the SBB Signet. Use according to documentation.
SBBMessage
The SBB Message widget displays messages to the user, typically for errors, loading states, or informational content.
SBBMessageStyle
Defines the visual properties of SBBMessage.
SBBMessageThemeData
The ThemeData for the SBBMessage.
SBBMultiDropdown<T>
The SBB Dropdown (multiple values).
SBBNotificationBox
The SBB Notification Box.
SBBNotificationBoxController
Controller for programmatically showing and hiding a SBBNotificationBox.
SBBNotificationBoxStyle
Defines the visual properties of SBBNotificationBox.
SBBNotificationBoxThemeData
The ThemeData for SBBNotificationBox.
SBBPaginator
The SBB paginator to display page navigation information
SBBPaginatorFloating
The floating variant of the SBB Paginator.
SBBPaginatorStyle
Defines the visual properties of SBBPaginator.
SBBPaginatorThemeData
The ThemeData for the SBBPaginator.
SBBPicker
The SBB Picker.
SBBPickerItem
Represents an item in the SBBPickerScrollView that is used by SBBPicker.
SBBPickerScrollController
A scroll controller for SBBPickerScrollView that is used by SBBPicker.
SBBPickerScrollView
A box in which children on a wheel can be scrolled. Should only be used in combination with SBBPicker.custom.
SBBPickerStyle
Defines the visual properties of SBBPicker and related widgets.
SBBPickerThemeData
The theme data for SBBPicker, SBBDatePicker, SBBTimePicker, SBBDateTimePicker, SBBDateInput, SBBTimeInput and SBBDateTimeInput.
SBBPopover
A popover anchored to a target widget, displayed in the enclosing Overlay above a modal barrier.
SBBPopoverController
Controller for programmatically showing and hiding an SBBPopover.
SBBPopoverPlacement
Where an SBBPopover is placed relative to its target: an edge (the main axis, subject to flip-on-collision) plus a cross-axis alignment along that edge (subject to clamping at the viewport edges).
SBBPopoverStyle
Defines the visual properties of SBBPopover.
SBBPopoverThemeData
The ThemeData for SBBPopover.
SBBPopup
The SBB Popup widget.
SBBPopupStyle
Defines the visual properties of SBBPopup.
SBBPopupThemeData
The ThemeData for SBBPopup.
SBBPrimaryButton
The primary variant of the SBB Button.
SBBPrimaryButtonThemeData
The ThemeData for the SBBPrimaryButton.
SBBPromotionBox
The SBB Promotion Box.
SBBPromotionBoxBadge
The default badge content for a SBB Promotion Box.
SBBPromotionBoxBadgeStyle
Defines the visual properties of the badge shown on top of SBBPromotionBox.
SBBPromotionBoxController
Controller for programmatically showing and hiding a SBBPromotionBox.
SBBPromotionBoxStyle
Defines the visual properties of SBBPromotionBox.
SBBPromotionBoxThemeData
The ThemeData for the SBBPromotionBox.
SBBRadio<T>
The SBB Radio.
SBBRadioGroup<T>
The SBB Radio Group.
SBBRadioListItem<T>
A convenience wrapper that combines SBBListItem with SBBRadio as the leading widget.
SBBRadioListItemBoxed<T>
A boxed variant of SBBRadioListItem with rounded borders.
SBBRadioStyle
Defines the visual properties of SBBRadio.
SBBRadioThemeData
The ThemeData for the SBBRadio.
SBBSecondaryButton
The secondary variant of the SBB Button.
SBBSecondaryButtonThemeData
The ThemeData for the SBBSecondaryButton.
SBBSegmentedButton<T>
The SBB Segmented Button.
SBBSegmentedButtonFilled<T>
Creates the filled style variant of SBBSegmentedButton.
SBBSegmentedButtonStyle
Defines the visual properties of SBBSegmentedButton.
SBBSegmentedButtonThemeData
The ThemeData for the SBBSegmentedButton.
SBBSlider
A slider component following the SBB design system.
SBBSliderStyle
Defines the visual properties of SBBSlider.
SBBSliderThemeData
The ThemeData for the SBBSlider.
SBBSlideToggleDecoration
Configuration for one side of an SBBSlideToToggle.
SBBSlideToToggle
The SBB Slide-To-Toggle.
SBBSlideToToggleSmall
The SBB Slide-To-Toggle with reduced toggle size.
SBBSlideToToggleStyle
Defines the visual properties of SBBSlideToToggle.
SBBSlideToToggleThemeData
The ThemeData for the SBBSlideToToggle.
SBBSliverHeaderBox
A floating version of SBBHeaderBox.
SBBSliverHeaderBoxConfig
A config for the sliver-specific behavior of SBBSliverHeaderBox.
SBBSliverHeaderBoxLarge
The large variant of SBBSliverHeaderBox.
SBBSliverHeaderBoxSpacer
A widget that adds space for a floating SBBSliverHeaderBox.
SBBSpacing
Spacing scale for SBB Design System.
SBBStatus
The SBB Status.
SBBStatusStyle
Defines the visual properties of SBBStatus.
SBBStatusThemeData
The ThemeData for the SBBStatus.
SBBStepper
The SBB Stepper. Use according to documentation.
SBBStepperItem
Represents a single step in an SBBStepper.
SBBStepperItemIcon
A step that displays an icon inside the step circle.
SBBStepperItemNumbered
A step that displays its (1-based) index number inside the step circle.
SBBStepperItemStyle
Defines the visual properties of SBBStepperItem of SBBStepper.
SBBStepperItemText
A step that displays custom text inside the step circle.
SBBStepperStyle
Defines the visual properties of SBBStepper.
SBBStepperThemeData
The ThemeData for the SBBStepper.
SBBSwitch
The SBB Switch.
SBBSwitchListItem
A convenience wrapper that combines SBBListItem with SBBSwitch as the trailing widget.
SBBSwitchListItemBoxed
A boxed variant of SBBSwitchListItem with rounded borders.
SBBSwitchStyle
Defines the visual properties of SBBSwitch.
SBBSwitchThemeData
The ThemeData for the SBBSwitch.
SBBTabBar
The TabBar for SBB themed apps with multiple tabs. Items is a list of all tabs that should be shown in the TabBar. OnTabChanged defines what happens when a tab is selected. OnTap gets called when a tab is tapped.
SBBTabBarBadge
A base class for badge widgets displayed in tab bar items.
SBBTabBarBadgeIcon
A badge widget that displays an icon inside a circular background.
SBBTabBarBadgeText
A badge widget that displays text inside a stadium-shaped (pill-shaped) background.
SBBTabBarController
With this Controller, the SBBTabBar can be controlled externally.
SBBTabBarItem
Description of an Element in the SBBTabBar
SBBTabBarItemBadge
A small badge widget displayed in the top-right corner of a tab bar item.
SBBTabBarLayoutData
Represents the positions of a SBBTabBarItem in SBBTabBar
SBBTabBarNavigationData
The data of the current state of the SBBTabBar
SBBTabBarStyle
Defines the visual properties of SBBTabBar.
SBBTabBarThemeData
The ThemeData for the SBBTabBar.
SBBTabBarWarningSetting
SBBTertiaryButton
The tertiary variant of the SBB Button.
SBBTertiaryButtonSmall
The tertiary variant of the SBB Button with reduced height.
SBBTertiaryButtonThemeData
The ThemeData for the SBBTertiaryButton and SBBTertiaryButtonSmall.
SBBTextInput
The SBB TextInput.
SBBTextInputBoxed
The boxed variant of SBBTextInput.
SBBTextInputBoxedFormField
The boxed variant of SBBTextInputFormField.
SBBTextInputFormField
The SBB TextInputFormField wraps SBBTextInput in a FormField.
SBBTextInputThemeData
The ThemeData for the SBBTextInput.
SBBTextStyles
Provides constants for all text styles defined in the SBB design system mobile.
SBBTextTheme
SBB Design System Mobile text theme.
SBBTheme
Base SBB theme builder.
SBBTimeInput
This is basically a convenience combination of a SBBDecoratedText and a SBBTimePicker.
SBBTimePicker
SBB Time Picker. Use according to documentation.
SBBTimePickerController
A controller for SBBTimePicker that allows programmatically setting the selected time, e.g. from instrumentation tests.
SBBToast
A dismissible message overlay that appears at the bottom of the screen, typically for transient notifications.
SBBToastAction
An action button for use within a SBBToast.
SBBToastStyle
Defines the visual properties of SBBToast.
SBBToastThemeData
The ThemeData for the SBBToast.
TabItemInteractions

Enums

SBBBadgeIconData
Icon options available for the badge icon type.
SBBContractionBehavior
Describes how an SBBContractible reacts as its available height decreases.
SBBFloatingLabelBehavior
Defines the behavior of the floating label in SBB input fields.
SBBHeaderBoxFlapMode
Defines how the flap attached to a sliver header box behaves during scroll.
SBBHeaderBoxTopMode
Defines how the top widget above a sliver header box behaves during scroll.
SBBInputBorderType
Defines if the input widget is standalone or listed/boxed to handle input border.
SBBNotificationBoxState
Defines the visual state of a SBBNotificationBox.
SBBPopoverAlignment
How an SBBPopover aligns with its target along the chosen edge.
SBBPopoverEdge
The edge of the target an SBBPopover is placed on.
SBBSlideToToggleState
State enum for the Slide-To-Toggle component.
SBBSlideToToggleTriggerMode
Defines the mode when SBBSlideToToggle triggers the toggle callback.
SBBStatusState
Defines the visual state of a SBBStatus.
SBBTabBarItemBadgeDisplayMode
Display mode options for the tab bar item badge.
SBBThemeContext
Defines the context in which the Theme is used. This currently only affects the used colors.

Extensions

SBBAccentButtonThemeDataX on SBBAccentButtonThemeData
SBBBaseStyleThemeDataX on ThemeData
SBBBottomSheetThemeDataThemeDataX on ThemeData
SBBBottomSheetThemeDataX on SBBBottomSheetThemeData
SBBButtonThemeDataThemeDataX on ThemeData
SBBCheckboxThemeDataThemeDataX on ThemeData
SBBCheckboxThemeDataX on SBBCheckboxThemeData
SBBChipThemeDataThemeDataX on ThemeData
SBBChipThemeDataX on SBBChipThemeData
SBBContentBoxStyleX on SBBContentBoxStyle?
SBBContentBoxThemeDataThemeDataX on ThemeData
SBBContentBoxThemeDataX on SBBContentBoxThemeData
SBBDecoratedTextThemeDataThemeDataX on ThemeData
SBBDecoratedTextThemeDataX on SBBDecoratedTextThemeData
SBBDecoratedThemeDataThemeDataX on ThemeData
SBBDecoratedThemeDataX on SBBDecoratedThemeData
SBBDividerThemeDataMergeX on DividerThemeData
SBBDropdownThemeDataThemeDataX on ThemeData
SBBDropdownThemeDataX on SBBDropdownThemeData
SBBHeaderBoxThemeDataX on SBBHeaderBoxThemeData
SBBHeaderBoxThemeOnThemeDataX on ThemeData
SBBHeaderThemeDataThemeDataX on ThemeData
SBBHeaderThemeDataX on SBBHeaderThemeData
SBBInputDecorationThemeDataThemeDataX on ThemeData
SBBInputDecorationThemeDataX on SBBInputDecorationThemeData
SBBInputDecorationThemeX on SBBInputDecoration
Extension on SBBInputDecoration that allows applying default values from SBBInputDecorationThemeData.
SBBLinearLoadingIndicatorThemeDataThemeDataX on ThemeData
SBBLinearLoadingIndicatorThemeDataX on SBBLinearLoadingIndicatorThemeData
SBBListHeaderThemeDataThemeDataX on ThemeData
SBBListHeaderThemeDataX on SBBListHeaderThemeData
SBBListItemThemeDataThemeDataX on ThemeData
SBBListItemThemeDataX on SBBListItemThemeData
SBBMessageThemeDataThemeDataX on ThemeData
SBBMessageThemeDataX on SBBMessageThemeData
SBBNotificationBoxThemeDataThemeDataX on ThemeData
SBBNotificationBoxThemeDataX on SBBNotificationBoxThemeData
SBBPaginatorThemeDataThemeDataX on ThemeData
SBBPaginatorThemeDataX on SBBPaginatorThemeData
SBBPickerThemeDataThemeDataX on ThemeData
SBBPickerThemeDataX on SBBPickerThemeData
SBBPopoverThemeDataThemeDataX on ThemeData
SBBPopoverThemeDataX on SBBPopoverThemeData
SBBPopupThemeDataThemeDataX on ThemeData
SBBPopupThemeDataX on SBBPopupThemeData
SBBPrimaryButtonThemeDataX on SBBPrimaryButtonThemeData
SBBPromotionBoxThemeDataThemeDataX on ThemeData
SBBPromotionBoxThemeDataX on SBBPromotionBoxThemeData
SBBRadioThemeDataThemeDataX on ThemeData
SBBRadioThemeDataX on SBBRadioThemeData
SBBSecondaryButtonThemeDataX on SBBSecondaryButtonThemeData
SBBSegmentedButtonThemeDataThemeDataX on ThemeData
SBBSegmentedButtonThemeDataX on SBBSegmentedButtonThemeData
SBBSliderThemeDataThemeDataX on ThemeData
SBBSliderThemeDataX on SBBSliderThemeData
SBBSlideToToggleThemeDataThemeDataX on ThemeData
SBBSlideToToggleThemeDataX on SBBSlideToToggleThemeData
SBBStatusThemeDataThemeDataX on ThemeData
SBBStatusThemeDataX on SBBStatusThemeData
SBBStepperThemeDataThemeDataX on ThemeData
SBBStepperThemeDataX on SBBStepperThemeData
SBBSwitchThemeDataThemeDataX on ThemeData
SBBSwitchThemeDataX on SBBSwitchThemeData
SBBTabBarThemeDataThemeDataX on ThemeData
SBBTabBarThemeDataX on SBBTabBarThemeData
SBBTertiaryButtonThemeDataX on SBBTertiaryButtonThemeData
SBBTextInputThemeDataThemeDataX on ThemeData
SBBTextInputThemeDataX on SBBTextInputThemeData
SBBTextSelectionThemeDataMergeX on TextSelectionThemeData
SBBTextStyleX on TextStyle
SBBTextThemeThemeDataX on ThemeData
SBBThemeContextX on SBBThemeContext
SBBToastThemeDataThemeDataX on ThemeData
SBBToastThemeDataX on SBBToastThemeData

Constants

largeFontFamily → const String
mediumFontFamily → const String
sbbFont → const String
Global constant for default SBB font family SBBFontFamily.sbbFontLight.
sbbIconSizeLarge → const double
sbbIconSizeMedium → const double
sbbIconSizeSmall → const double
sbbTextStyle → const TextStyle
Global constant for default SBB text style for easier use of extension methods defined in SBBTextStyleX.
smallFontFamily → const String

Functions

showSBBBottomSheet<T>({Key? key, required BuildContext context, Widget? title, String? titleText, Widget? leading, IconData? leadingIconData, Widget? trailing, IconData? trailingIconData, required Widget body, SBBBottomSheetStyle? style, String? barrierLabel, bool isScrollControlled = false, double scrollControlDisabledMaxHeightRatio = _defaultScrollControlDisabledMaxHeightRatio, bool useRootNavigator = true, bool isDismissible = true, bool enableDrag = true, bool useSafeArea = true, AnimationController? transitionAnimationController, AnimationStyle? sheetAnimationStyle, bool showCloseButton = true, bool? requestFocus, RouteSettings? routeSettings}) → Future<T?>
Shows an SBB Bottom Sheet.
showSBBPopup<T>({Key? key, required BuildContext context, Widget? title, String? titleText, Widget? leading, IconData? leadingIconData, Widget? trailing, IconData? trailingIconData, required Widget body, SBBPopupStyle? style, bool useRootNavigator = true, bool isDismissible = true, bool showCloseButton = true, bool useSafeArea = true, TraversalEdgeBehavior? traversalEdgeBehavior, bool fullscreenDialog = false, bool? requestFocus, AnimationStyle? animationStyle, String? barrierLabel, RouteSettings? routeSettings}) → Future<T?>
Shows an SBB Popup dialog.

Typedefs

AutoCompleteOverlayItemBuilder<T> = Widget Function(BuildContext context, T suggestion)
ContractibleBuilder = Widget Function(BuildContext context, SBBContractibleState state, Widget? child)
ContractionListenerBuilder = Widget Function(BuildContext context, SBBContractionState state, Widget? child)
Filter<T> = bool Function(T suggestion, String query)
InputEventCallback<T> = dynamic Function(T data)
OnStepPressedCallback = void Function(SBBStepperItem item, int index)
SBBMultiDropdownLabelAggregation<T> = String Function(List<SBBDropdownItem<T>> selectedItems)
Signature for custom label aggregation used in SBBMultiDropdown to produce the display string shown in the trigger field.
SBBMultiDropdownValidation<T> = bool Function(List<T> oldSelection, List<T> newSelection)
Signature for custom selection validation used in SBBMultiDropdown to determine whether the confirm button is enabled.
SBBPickerScrollViewItemBuilder = SBBPickerItem? Function(BuildContext context, int index)
Signature for a function that creates a SBBPickerItem for a given index, but may return null.
SBBPromotionBoxBackgroundBuilder = Widget Function(BuildContext context, SBBPromotionBoxStyle style, Widget child)
A builder that creates a custom background for SBBPromotionBox.
SBBStepperSemanticValueBuilder = String Function(int index, int stepCount)
Builds the position announcement of the step at index of stepCount steps.
StringCallback = dynamic Function(String data)
TabItemInteractionsBuilder = TabItemInteractions Function(SBBTabBarItem)