Legacy version 5 documentation. View current documentation.Legacy version 5 documentation. View current documentation.
Below is an index of each function and component exported from the Finsemble UI API.
| Control | Summary |
|---|---|
| AdvancedAppLauncherMenu | A control that launches the Advanced App Launcher as a menu. |
| AlwaysOnTopButton | A control for enabling always-on-top. |
| AppLauncherMenu | A control that launches the App Launcher as a menu. |
| AutoArrange | A button that auto-arranges all windows on the same monitor as the toolbar. |
| CentralLogger | A menu item that opens the central logger. |
| CloseButton | A control for closing the window. |
| Documentation | A menu that opens this documentation site. |
| DragHandle | A control that users may click and drag to move the toolbar. |
| FavoriteMaker | A "star" icon that toggles a favorite on and off |
| FavoritesShell | A container for favorites where users can launch and organize their favorites |
| FinsembleProvider | A wrapper that provides the necessary context for communication with the rest of the SmartDesktop system. |
| General | The general section of the preferences menu. |
| GroupingButton | A control for forming and disbanding window groups. |
| Icon | A Finsemble-themed icon. |
| LinkerButton | A control opening the Linker Menu and displaying active Linker channels. |
| MaximizeButton | A control for maximizing the window. |
| Menu | A component that creates a fully functioning drop down menu. |
| MenuContent | Advanced. The actual drop-down menu. All contents inside <MenuContent> will be displayed to the user |
| MenuItem | Optional. A container that can be used within a menu. This allows cursor up/down navigation and can automatically close the menu on clicks. |
| MenuShell | Advanced. Provides a shell for the menuing mechanism. It creates and registers a menu {i.e. with the toolbar)}. |
| MenuToggle | Advanced. A button that opens and closes the menu. |
| Menu | A component that creates a fully functioning drop down menu. |
| MenuContent | Advanced. The actual drop-down menu. All contents inside <MenuContent> will be displayed to the user |
| MenuToggle | Advanced. A button that opens and closes the menu. |
| MenuItem | Optional. A container that can be used within a menu. This allows cursor up/down navigation and can automatically close the menu on clicks. |
| MenuShell | Advanced. Provides a shell for the menuing mechanism. It creates and registers a menu {i.e. with the toolbar)}. |
| MinimizeAll | A button that minimizes all the SmarDesktop's active windows. |
| MinimizeButton | A control for minimizing the window. |
| Preferences | An menu item that opens the Preferences window. |
| Quit | A menu item that quits the SmartDesktop. |
| Reset | A menu item that resets the SmartDesktop to its initial state, destroying all workspaces, custom apps, etc (use with caution!). |
| Restart | A menu item that restarts the SmartDesktop. |
| RevealAll | A button that unminimizes and brings to focus all the SmartDesktop's active windows. |
| Search | A component that enables the user to search across their entire SmartDesktop. |
| ShareButton | A control for sharing data with other windows via drag-and-drop. |
| SystemLog | A menu item that opens the system log. |
| SystemTrayComponentShell | A wrapper that provides the necessary context for the System Tray component. |
| TabRegion | A control for forming and rearranging tabs of windows. Also displays the window's title. |
| ToolbarSection | A React component rendering a section of the toolbar. |
| ToolbarShell | A wrapper providing the necessary context for the toolbar. |
| useAuth | A hook to help with authenticating the user into the SmartDesktop. |
| useAuthSimulator | A hook providing helper functions to simluate authenticating the user into the SmartDesktop. |
| useHotkey | A hook to register hotkeys with the SmartDesktop. |
| WindowTitleBarShell | A higher-order React component that provides the necessary context for the window title bar. |
| WorkspaceManagementMenu | A control that launches the workspace management menu. |
| Workspaces | The workspaces section of the preferences menu. |