tide_kit library

Classes

MockUpgraderOS
A class to mock UpgraderOS for testing.
NotificationsCenter
Tide
TideAction
An action is a command with a title, menu, keybinding, and can be exposed in the UI.
TideActivateIntent
TideActivityBar
An activity bar is a vertical bar on the side of the workbench that contains various icon buttons.
TideActivityBarItem
TideActivityBarState
TideActivityContribution
TideActivityRegistry
TideApp
The use of this widget is optional and does not affect the functionality of the Tide app. It is provided as a convenience to help you get started with your app. This widget can be the root of a Tide application. The real entry point is the TideWindow widget.
TideCalendarDayPane
A widget that displays a calendar day pane.
TideCommand
A command is a runnable function defined by an ID.
TideCommandContribution
A command contribution is a collection of commands that are registered with the command registry. This is not necessary for all commands, but is useful for organizing the handler for a command.
TideCommandIds
TideCommandRegistry
TideCommandService
The command service that is created when Tide is initialized. To use a different command service, create a class that extends TideCommandService and register it before Tide is initialized.
TideConsole
A console is a panel that displays log messages.
TideExtension
An extension is a class that registers various commands, actions, contributions, and widgets to build a cohesive feature.
TideId
TideIds
TideKeybinding
A key binding is a combination of keys (key set) that trigger a command.
TideKeybindingContribution
TideKeybindingRegistry
TideKeybindingService
This class is used to process key events and is a Tide level service.
TideKeyboardListener
TideLoggingService
The logging servcie is used to log messages to be displayed in the console.
TideLogicalKeyIntent
TideNotification
A notification is a rich interactive message that is briefly displayed over the workbench.
TideNotificationService
A service that can be used to display notifications on the workbench.
TideNotificationServiceState
TideOS
A class that indicates which OS this code is running on.
TidePanel
A panel is part of a workbench and displays the content. A TidePanel is a model for a workbench panel. Panels are displayed using a TidePanelWidget.
TidePanelTitleBar
TidePanelWidget
TideQuickInput
A way to gather user input.
TideQuickInputBox
A way to gather user input from a TextField.
TideQuickInputBoxWidget
TideQuickPick
A way to gather user input from a list of items.
TideQuickPickItem
TideQuickPickItemWidget
TideQuickPickWidget
TideRegistry
TideResizer
Adds a resizer over the child widget.
TideRoundCloseIcon
TideSearchPanel
A panel that displays a search field and search results.
TideSelectionActionDetector
TideServiceIds
TideShowPanelAndFocusContribution
Contributes a command that makes a panel visible and requests focus on a focus node, like a TextField focus node.
TideStatusBar
A status bar is a short widget that is displayed at the bottom of a workbench and contains various items of minimal content. The content area of a status bar item has a default height of 22 pixels.
TideStatusBarItem
TideStatusBarItemContainer
TideStatusBarItemContainerState
Used by TideStatusBarItemContainer as internal state.
TideStatusBarItemProgress
TideStatusBarItemProgressWidget
A status bar item that displays a progress bar.
TideStatusBarItemText
TideStatusBarItemTextWidget
TideStatusBarItemTime
TideStatusBarItemTimeWidget
A status bar item that displays the current time. Make sure to initialize the time service like this:
TideStatusBarState
TideTextField
TideTimeService
A wall clock time service that outputs a stream. Example usage:
TideTimeState
The state that is output in the stream by TideTimeService.
TideTogglePanelVisibilityContribution
Contributes a command that toggles the visibility of a panel.
TideToggleStatusBarVisibilityContribution
Contributes a command that toggles the visibility of the status bar.
TideWindow
A window is a top-level widget that contains a workbench.
TideWorkbench
A workbench is the main widget that contains the activity bar, panels, and status bar. It is a child of the TideWindow widget.
TideWorkbenchAccessor
Provides access to the workbench accessor to get instance of registered objects. Example:
TideWorkbenchLayoutService
TideWorkbenchLayoutState
TideWorkbenchService
The workbench service that is created when Tide is initialized. To use a different workbench service, create a class that extends TideWorkbenchService and register it before Tide is initialized. There should only be one workbench service.
UpgraderOS
A class that indicates which OS this code is running on.

Functions

dispatch(void computation()) → void
A convenience function to run a function (computation) in the next event loop.

Typedefs

TideActivityBarItemBuilder = TideActivityBarItem? Function(BuildContext context, TideId barId)
TideCommandHandler = void Function(TideCommand command, TideCommandParams commandParams, TideServicesAccessor accessor)
TideCommandParams = Map<String, Object>
TideCommandsMap = Map<String, TideCommand>
TideCreateHandler = void Function()
TideOnPressedItemCallback = void Function(BuildContext context, TideStatusBarItem item)
Signature of callbacks that have no arguments and return no data.
TidePanelBuilder = TidePanelWidget? Function(BuildContext context, TidePanel panel)
TideServicesAccessor = GetIt
A service accessor for the Tide services to get an instance to an object.
TideStatusBarItemBuilder = Widget? Function(BuildContext context, TideStatusBarItem item)