📄️ AdvancedAppLauncherMenu API
The ` component provides a richer end user experience than `. It is designed for use cases involving a large number of applications, with features for searching and organizing apps. Features include:
📄️ AlwaysOnTopButton API
The `` component is button for the window title bar that triggers the always-on-top state for the
📄️ AppLauncherMenu API
`` is a drop-down menu that provides a list of installed applications. Users can launch applications by
📄️ AutoArrange API
The `` component renders a button that, when clicked, causes all active windows to organize into a
📄️ CentralLogger API
`` renders a button that launches the Central Logger debugging tool. You can read more about the central logger here.
📄️ CloseButton API
The `` component is button for the window title bar that closes the window.
📄️ Documentation API
`` renders a button that launches this documentation site.
📄️ DragHandle API
`` renders a DOM element that the mouse can grab to move the toolbar around the screen.
📄️ FavoriteMaker API
The `` component renders a button that, when clicked, adds a specific item (specified via props) to the
📄️ FavoritesShell API
The `` component renders a horizontal list of the users currently favorited items. The user can click
📄️ FinsembleProvider API
The UI API uses React Context to provide the setup to your UI component with
📄️ General API
The `` component is used in the User Preferences Menu.
📄️ GroupingButton API
The `` component is button that toggles the grouping state of a window (and potentially other windows
📄️ Icon API
The `` component creates a visual icon to represent applications, workspaces or other items. An icon can be
📄️ LinkerButton API
The `` component is button that launches the linker menu for the window. It is included in the default window titlebar.
📄️ MaximizeButton API
The `` component is button for the window title bar that maximizes the window.
📄️ Menu API
The UI API library enables easy creation and customization of Finsemble-themed menus on the toolbar. The ``
📄️ MenuContent API
` contains the contents of menu's drop-down. ` may contain any valid jsx. See also the
📄️ MenuItem
You can use ` to organize your menu. You register onClick handlers to respond to user selection. automatically closes the menu unless you specify the noClose` attribute. It also makes the item available via
📄️ MenuShell
` is the root component of any menu. All other menuing components must be children of `.
📄️ MenuToggle API
`` is a button that opens and closes the drop-down menu. It can contain any content that you wish: text,
📄️ MinimizeAll
A button that minimizes all windows in the current workspace.
📄️ MinimizeButton API
The `` component is button for the window title bar that minimizes the window.
📄️ NotificationCardBodyShell
The ` is part of a group of components that allow full customization of the notification card. The ` allows creating a custom notification while keeping built-in rendering of actions.
📄️ NotificationCardHeaderShell
The ` is part of a group of components that allow full customization of the notification card. The ` allows creating a custom header while keeping the built-in Notification context menu features such as "Mark Read" or "Snooze".
📄️ NotificationCardShell
The NotificationCardShell provides a wrapper for creating a custom notification card. The shell provides the new notification highlight functionality seen in the Notification Center.
📄️ NotificationListRowShell
The `` allows customization of the Notification Center's list view while keeping the built-in Notification context menu features such as "Mark Read" or "Snooze".
📄️ Preferences API
The `` component renders a button that launches Finsemble's
📄️ Quit API
The ` component is a ` component that quits the SmartDesktop on click. It is
📄️ Reset API
The ` component is a component similar to `, except that it
📄️ Restart API
The ` component is a ` component that restarts the SmartDesktop on click.
📄️ Reveal API
The `` component renders a button that reveals (restores from minimize and brings to front) all windows in the current workspace.
📄️ Search API
The `` component renders a menu that provides a way for users to enter searches that use Finsemble's Search Client API. Users can launch, favorite, or unfavorite search results. By default, Finsemble is configured to return search results for installed Components (Apps) and Workspaces. Search will automatically return results for any "providers" that are registered with Finsemble via the Search API.
📄️ ShareButton API
This feature is deprecated starting with Finsemble 6.5. It is no longer supported and will likely go away in the future.
📄️ SystemLog API
The `` renders a button that, when clicked, displays the system log, which can be used to diagnose startup
📄️ SystemTrayComponentShell API
The `` component provides the necessary context for the system tray menu.
📄️ TabRegion API
The `` component is region included in the default window title bar that displays a tab for each window in
📄️ UserPreferences API
The UserPreferences component renders the user preferences menu. The default user preferences comes with a daily
📄️ WindowTitleBarShell API
The `` component wraps the rest of the window title bar, handling layout and low-level
📄️ WorkspaceManagementMenu
The `` renders a menu that enables users to create, delete, save, favorite, and switch between
📄️ Workspaces API
The `` component is used in the User Preferences Menu.
📄️ ToolbarSection API
` is a container element for organizing the toolbar into sections. The `'s are all
📄️ ToolbarShell API
`` is the root component of the Finsemble's Toolbar Component. It is a non-displaying component that acts
📄️ useAuth API
The useAuth hook is a React hook that acts as a high-level interface for authorization.
📄️ useAuthSimulator API
The useAuthSimulator hook can be used to test authentication components.
📄️ useHotkey API
This hook can be used to register a global hotkey. It makes use of Finsemble's HotkeyClient API.