nes_ui library
UI library inspired by old retro video game console
Classes
- NesBasicDialogFrame
- A dialog frame with a basic style. Which is the default style for a dialog.
- NesBlinker
- A widget that blinks its child.
- NesBottomSheet
- A NesBottomSheetPainter that paints a NES-style bottom sheet.
- NesBottomSheetPainter
- Base class for NesBottomSheetPainter painters.
- NesBottomSheetRoundedBorderPainter
- A NesBottomSheetPainter that paints a NES-style bottom sheet with rounded borders.
- NesBottomSheetTheme
- A NesBottomSheetPainter that paints a NES-style bottom sheet.
- NesButton
- Renders a pressable button.
- NesButtonTheme
- Class with information regarding buttons inside Flutter Nes.
- NesCheckBox
- A Check Box widget.
- NesCheckeredDecoration
- A decoration that paints a checkered pattern.
- NesConfirmDialog
- A dialog that shows a message requiring an confirmation from the user.
- NesContainer
- A bordered container, with an optional label.
- NesContainerCornerInnerSquarePainter
- A NesContainerPainter that renders small squares inside it's corner.
- NesContainerPainter
- Base class for NesContainer painters.
- NesContainerRoundedBorderPainter
- A NesContainerPainter that renders a rounded border.
- NesContainerSquareCornerPainter
- A NesContainerPainter that renders squares in their corners, connected by double lines.
- NesContainerTheme
- Class with information regarding containers inside NesUI.
- NesController
- Provides a NesInputController down the widget tree.
- NesControllerFocus
- A Nes UI wrapper around Focus widgets that allows input from the library to be captured and listened.
- NesDialog
- A dialog that shows a message requiring an confirmation from the user.
- NesDialogFrame
- A class with information about the styel of a dialog frame.
- NesDropshadow
- Renders a dropshadow around the child in the NES style.
- NesFile
- Describes a file.
- NesFileEntity
- Describes a file or folder.
- NesFileExplorer
- A widget that displays a list of folders and files in a tree format.
- NesFillTransition
- A Transition that fills the screen.
- NesFixedViewport
- A widget that imposes a fixed resolution on its child.
- NesFixedViewportScaling
- An InheritedWidget that provides the current scale imposed by a NesFixedViewport down the widget tree.
- NesFolder
- Describes a folder.
- NesHorizontalCloseTransition
- A Transition that looks like horizontal doors are closing in front of the current screen, opening again with the new one.
- NesHorizontalGridTransition
- A Transition where lines will appear from the left and right until the screen is filled.
- NesHourglassLoadingIndicator
- A loading indicator that displays an hourglass that rotates.
- NesIcon
- Widget that renders icons from the Flutter Nes design library.
- NesIconBadge
- Widget that renders icons from the Flutter Nes design library.
- NesIconButton
- A button widget that wraps a NesIcon into a pressable button.
- NesIconCollection
- This is the internal class that holds the data for NesIcons. Use NesIcons to access the icons.
- NesIconData
- Model class holding the data of for a NesIcon.
- NesIcons16
- Built in library of 16x16 icons for the Flutter Nes Design library. Use NesIcons to access the icons.
- NesIconTheme
- Class with information regarding icons inside Flutter Nes.
- NesInputAdapter
- Base class for Nes UI controller adapters. Implement it to add a new adapter to the library.
- NesInputBorder
- Class used to render TextField inputs using Flutter nes style.
- NesInputController
- The central class that controls all controller adapters of Nes UI.
- NesInputDialog
- A dialog that shows a message requiring a value to input from the user.
-
NesIterableOptions<
T> - A widget that allows users to cycle through options.
- NesJumpingIconsLoadingIndicator
- A loading indicator where icons change into other icons.
- NesKeyboardInputAdapter
- A NesInputAdapter that uses the keyboard for input.
- NesKeyboardKeyMapping
- A model that defines the key mapping for the keyboard on the Nes Ui library.
- NesKeyIcon
- A pressable icon, representing a single key.
- NesMutatingIconsLoadingIndicator
- A loading indicator where icons change into other icons.
- NesOverlayTransitionTheme
- Class with information regarding overlay transitions.
- NesOverlayTransitionWidget
- Base widget for all of the Nes UI transition animation.
- NesPixelRowLoadingIndicator
- A loading indicator that displays a sequence of pixels.
- NesPressable
- A widget that allows a child to be pressable. Meaning that it can be clicked or touched.
- NesPulser
- A widget that pulses its child.
- NesRunningText
- A widget that displays a text that runs from right to left.
- NesRunningTextLines
- A widget that displays running text, one line after the other.
- NesScaffold
- A Nes UI system scaffold widget.
- NesScaffoldMessenger
- Manages widgets displayed by a NesScaffold.
- NesScaffoldMessengerState
- Handles the state of a NesScaffoldMessenger.
- NesScrollbar
- A scrollbar used in scrollable widgets inside Nes UI.
- NesSectionHeader
- An opninated section header for the NES UI. Consists of a title and a Divider
- NesSelectionList
- NesSelectionListTheme
- Class with information regarding Selection Lists.
- NesSingleChildScrollView
- A scroll view that can host a single child widget inside itself.
- NesSnackbar
- A SnackBar with a NES style.
- NesSnackbarTheme
- Class with information regarding buttons inside Flutter Nes.
- NesSplitPanel
- A widget that splits the available space into multiple panes.
- NesSplitPanelResizeHandler
- A widget that handles the resizing of the split panel.
- NesTab
- A tab that uses the NesUi style.
- NesTabItem
- Describes a tab used in a NesTabView.
- NesTabView
- A tab view that uses the NesUi style.
- NesTerminalLoadingIndicator
- A loading indicator that uses character to display a loading indicator.
- NesTheme
- Class with general theme information for Flutter Nes.
- NesTooltip
- A tooltip that appears when the user long-presses on a widget, or hovers over it with a mouse.
- NesTooltipTheme
- Class with information regarding tooltips inside NesUI.
- NesVerticalCloseTransition
- A Transition that looks like vertical doors are closing in front of the current screen, opening again with the new one.
- NesVerticalGridTransition
- A Transition where lines will appear from the left and right until the screen is filled.
- NesWindow
- A widget that renders a window with a NES style.
- NesWindowDialogFrame
- A dialog frame with a window style, using NesWindow.
Enums
- NesButtonType
- Defines the type of a NesButton.
- NesInputEvent
- Type of events for external controllers.
- NesSnackbarType
- The type of NesSnackbar to display.
- NesTooltipArrowDirection
- Enum with the possible direction for the arrow of the tooltip.
- NesTooltipArrowPlacement
- Enum with the possible placements for the arrow of the tooltip.
Extensions
- NesBuildContext on BuildContext
- Helper methods on BuildContext for the Flutter Nes.
Properties
- NesIcons → NesIconCollection
-
Built in library of icons for the Flutter Nes Design library.
final
Functions
-
flutterNesTheme(
{Color primaryColor = const Color(0xffb4b6f6), Brightness brightness = Brightness.light, NesTheme nesTheme = const NesTheme(pixelSize: 4), NesButtonTheme nesButtonTheme = const NesButtonTheme(normal: Color(0xffffffff), primary: Color(0xff209cee), success: Color(0xff92cc41), warning: Color(0xfff7d51d), error: Color(0xffe76e55), lightLabelColor: Color(0xffffffff), darkLabelColor: Color(0xff000000), lightIconTheme: NesIconTheme(primary: Color(0xffffffff), secondary: Color(0xff000000), accent: Color(0xff9badb7), shadow: Color(0xff696a6a)), darkIconTheme: NesIconTheme(primary: Color(0xff000000), secondary: Color(0xffffffff), accent: Color(0xff696a6a), shadow: Color(0xff9badb7))), NesIconTheme? nesIconTheme, NesSelectionListTheme nesSelectionListTheme = const NesSelectionListTheme(markerSize: Size(24, 24), itemMinHeight: 32), NesOverlayTransitionTheme? nesOverlayTransitionTheme, NesSnackbarTheme nesSnackbarTheme = const NesSnackbarTheme(normal: Color(0xffffffff), success: Color(0xff92cc41), warning: Color(0xfff7d51d), error: Color(0xffe76e55)), NesTooltipTheme? nesTooltipTheme, NesContainerTheme? nesContainerTheme, NesBottomSheetTheme? nesBottomSheetTheme, Iterable< ThemeExtension> customExtensions = const []}) → ThemeData - Creates a Flutter Nes ThemeData.
Typedefs
- NesBottomSheetPainterBuilder = NesBottomSheetPainter Function({required Color backgroundColor, required Color borderColor, required int pixelSize})
- Definition for a function that builds a NesBottomSheetPainter.
- NesContainerPainterBuilder = NesContainerPainter Function({required Color backgroundColor, required Color borderColor, required String? label, required int pixelSize, required TextStyle textStyle})
- Definition for a function that builds a NesContainerPainter.
- NesFileExplorerFileIconResolver = NesIconData? Function(NesFile file)
- A function that resolves an icon for a file.