AlwaysOnTopButton API

The <AlwaysOnTopButton> component is button for the window title bar that triggers the always-on-top state for the window when clicked, forcing the window to always appear above other windows, regardless of focus.

Even when used in the window title bar's template, the <AlwaysOnTopButton> will only show itself for components that have the feature enabled in config. See the config reference.

Props

<AlwaysOnTopButton> accepts no props.

Usage

Here's how the <AlwaysOnTopButton> component is used in the default window title bar:

<WindowTitleBarShell>
    ...
    <div className="fsbl-header-right">
        ...
        <AlwaysOnTopButton />
        ...
    </div>
    ...
</WindowTitleBarShell>