# FloatButton

> Deprecated. A button that floats over the page content; actions belong in the page's header or toolbar instead.

Source: https://raft-design.botiverse.build/components/float-button. Generated from the current release; where it differs from what you remember, this page is right.

FloatButton and FloatButtonGroup are deprecated and are removed in raft-ui 1.0. They are not part of the Raft Design System: in Raft, controls sit flat in the layout, and only menus, popups, dialogs and toasts float above the page ([Elevation](https://raft-design.botiverse.build/foundations/elevation.md)). Put the action in the page's header or toolbar instead: on desktop and on a phone's pushed page, that is `PanelActions` in the panel header ([Panel](https://raft-design.botiverse.build/components/panel.md)).

The one kind of control that floats over content is the jump pill of a conversation, which takes the person somewhere in the message list instead of doing an action, and it is a Button without a shadow, not a FloatButton ([Elevation](https://raft-design.botiverse.build/foundations/elevation.md#floating-controls)).

## When to use

| Situation                                                     | Use                                                                               |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| An action for the whole page or panel                         | A `PanelAction` in the panel header ([Panel](https://raft-design.botiverse.build/components/panel.md))                  |
| An action in a toolbar, such as New Task over a list of tasks | The toolbar's own button ([Tasks](https://raft-design.botiverse.build/components/tasks.md))                             |
| Any other action                                              | [Button](https://raft-design.botiverse.build/components/button.md), in the layout                                      |
| Back to Bottom, new messages, the next unread thread          | The jump controls of [MessageList](https://raft-design.botiverse.build/components/message-list.md#jump-controls) |

## API

### FloatButton

Deprecated: Not part of the Raft Design System; place actions in the page's header or toolbar. Removed in raft-ui 1.0.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `description` | `ReactNode` |  |  |
| `icon` | `ReactNode` |  |  |
| `offset` | `FloatButtonOffset` |  |  |
| `position` | `FloatButtonPosition` |  |  |
| `shape` | `FloatButtonShape` |  |  |
| `side` | `FloatButtonSide` |  |  |
| `size` | `FloatButtonSize` |  |  |
| `tooltip` | `ReactNode` |  |  |
| `variant` | `FloatButtonVariant` | `"default"` |  |
| `focusableWhenDisabled` | `boolean` | `false` | Whether the button should be focusable when disabled. |
| `nativeButton` | `boolean` | `true` | Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (for example, `<div>`). |
| `render` | `ReactElement \| ((props, state) => ReactElement)` |  | Allows you to replace the component's HTML element with a different tag, or compose it with another component. |

Also takes the attributes of its element.

### FloatButtonGroup

Deprecated: Not part of the Raft Design System; place actions in the page's header or toolbar. Removed in raft-ui 1.0.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `attached` | `boolean` | `false` |  |
| `direction` | `FloatButtonGroupDirection` | `"vertical"` |  |
| `gap` | `string \| number` |  |  |
| `offset` | `FloatButtonOffset` |  |  |
| `position` | `FloatButtonPosition` |  |  |
| `shape` | `FloatButtonShape` | `"circle"` |  |
| `side` | `FloatButtonSide` |  |  |
| `size` | `FloatButtonSize` |  |  |
| `render` | `ReactElement \| ((props, state) => ReactElement)` |  | Allows you to replace the component's HTML element with a different tag, or compose it with another component. |

Also takes the attributes of its element.

## Changes

- 0.7.0 (Changed): Deprecated, to be removed in 1.0: `FloatButton` / `FloatButtonGroup` (not part of the design system), `LegacyTaskPanel*` (unused), and `LiveAgentActivityBar*` (the design system shows working agents where they appear).