GPUI Component

https://docs.rs/gpui-component/latest/gpui_component/
Admin
A comprehensive library providing a set of reusable UI components for building applications with the...
Tokens:15,199,895
Snippets:65,772
Trust Score:9.1
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### init(cx: &mut App)

Source: https://docs.rs/gpui-component/latest/gpui_component/theme/fn.init.html

Initializes the theme system for the gpui_component library. Call this function during application setup to enable theme support.

```APIDOC
## init(cx: &mut App)

### Description
Initializes the theme system for the gpui_component library. Call this function during application setup to enable theme support.

### Method
Function

### Signature
```rust
pub fn init(cx: &mut App)
```

### Parameters
- **cx** (`&mut App`) - Required - A mutable reference to the application context.

### Return Value
- `()` - Returns nothing.

### Example
```rust
use gpui_component::theme::init;

init(&mut app);
```
```

--------------------------------

### line_start_offset example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/trait.RopeExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example for line_start_offset. It returns the start offset of the line at the given 0-based row index.

```rust
use gpui_base::input::{Rope, RopeExt};

let rope = Rope::from("Hello\nWorld\r\nThis is a test 中文\nRope");
assert_eq!(rope.line_start_offset(0), 0);
assert_eq!(rope.line_start_offset(1), 6);
```

--------------------------------

### theme::init

Source: https://docs.rs/gpui-component/latest/gpui_component/all.html?search=

Initializes the theme system.

```APIDOC
## theme::init

### Description
Initializes the theme system.

### Function
theme::init
```

--------------------------------

### line_start_offset example

Source: https://docs.rs/gpui-component/latest/gpui_component/trait.RopeExt.html?search=std%3A%3Avec

Example for line_start_offset: returns the start offset of the line at the given 0-based row index.

```rust
use gpui_base::input::{Rope, RopeExt};

let rope = Rope::from("Hello\nWorld\r\nThis is a test 中文\nRope");
assert_eq!(rope.line_start_offset(0), 0);
assert_eq!(rope.line_start_offset(1), 6);
```

--------------------------------

### init(cx: &mut App)

Source: https://docs.rs/gpui-component/latest/gpui_component/fn.init.html?search=

Initializes the components. This function must be called at the application's entry point before using any components.

```APIDOC
## init(cx: &mut App)

### Description
Initializes the components. This function must be called at the application's entry point before using any components.

### Function Signature
```rust
pub fn init(cx: &mut App)
```

### Parameters
- **cx** (&mut App) - Required - The application context used for initialization.

### Usage
Call this function at the entry point of your application to initialize the components.

### Return Value
This function does not return a value.
```

--------------------------------

### Rc::try_map example (nightly)

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Example for the nightly-only experimental API `Rc::try_map`. It attempts to map the value in an `Rc`, reusing the allocation if possible. The closure returns a `Result` and the example unwraps it to get the new `Rc`.

```rust
#![feature(smart_pointer_try_map)]

use std::rc::Rc;

let b = Rc::new(7);
let new = Rc::try_map(b, |&i| u32::try_from(i)).unwrap();
assert_eq!(*new, 7);
```

--------------------------------

### init

Source: https://docs.rs/gpui-component/latest/gpui_component/fn.init.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Documentation for the init function that initializes the components.

```APIDOC
## Function init

### Description
Initializes the components. Must be called at the application's entry point.

### Signature
```rust
pub fn init(cx: &mut App)
```

### Parameters
- **cx** (`&mut App`) - Required - The application context.

### Usage
Call this function at the start of your application to initialize the components.
```

--------------------------------

### Rc::strong_count example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Shows how to use Rc::strong_count to get the number of strong (Rc) pointers to an allocation. The example creates an Rc, clones it, and asserts the count is 2.

```rust
use std::rc::Rc;

let five = Rc::new(5);
let _also_five = Rc::clone(&five);

assert_eq!(2, Rc::strong_count(&five));
```

--------------------------------

### Grid::new

Source: https://docs.rs/gpui-component/latest/gpui_component/plot/struct.Grid.html?search=

Creates a new Grid instance with default settings.

```APIDOC
## Grid::new

### Description
Creates a new Grid instance with default settings.

### Method
new

### Signature
pub fn new() -> Grid

### Parameters
None

### Returns
- **Grid** - A new Grid instance.

```

--------------------------------

### Rc::weak_count example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Shows how to use Rc::weak_count to get the number of Weak pointers to an allocation. The example creates an Rc, downgrades it to a Weak, and asserts the count is 1.

```rust
use std::rc::Rc;

let five = Rc::new(5);
let _weak_five = Rc::downgrade(&five);

assert_eq!(1, Rc::weak_count(&five));
```

--------------------------------

### Rc::get_mut example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Shows how to use Rc::get_mut to get a mutable reference when there are no other Rc or Weak pointers. The example mutates the value, then clones the Rc and verifies that get_mut returns None.

```rust
use std::rc::Rc;

let mut x = Rc::new(3);
*Rc::get_mut(&mut x).unwrap() = 4;
assert_eq!(*x, 4);

let _y = Rc::clone(&x);
assert!(Rc::get_mut(&mut x).is_none());
```

--------------------------------

### Grid::new

Source: https://docs.rs/gpui-component/latest/gpui_component/plot/struct.Grid.html?search=u32+-%3E+bool

Creates a new Grid instance with default settings.

```APIDOC
## Grid::new

### Description
Creates a new Grid instance.

### Method
`pub fn new() -> Grid`

### Parameters
None.

### Returns
- **Grid** - A new Grid instance.

### Example
```rust
let grid = Grid::new();
```
```

--------------------------------

### Grid::new

Source: https://docs.rs/gpui-component/latest/gpui_component/plot/struct.Grid.html?search=std%3A%3Avec

Creates a new Grid instance with default settings.

```APIDOC
## Grid::new

### Description
Creates a new `Grid` instance.

### Method
`pub fn new() -> Grid`

### Parameters
None.

### Returns
- `Grid` - A new grid instance.
```

--------------------------------

### SliderValue::start

Source: https://docs.rs/gpui-component/latest/gpui_component/slider/enum.SliderValue.html?search=std%3A%3Avec

Gets the start value of the slider. For a single value, returns that value; for a range, returns the first element.

```APIDOC
## SliderValue::start

### Description
Gets the start value of the slider. For a single value, returns that value; for a range, returns the first element.

### Method
`pub fn start(&self) -> f32`

### Returns
- **f32** - The start value.
```

--------------------------------

### focused_input(&mut self, cx: &mut App) -> Option<AnyInputState>

Source: https://docs.rs/gpui-component/latest/gpui_component/trait.WindowExt.html

Return the currently focused input state. Covers `Input`, `Textarea`, `Editor` and `OtpInput`, use `AnyInputState::as_input` and friends to get the concrete state. A registration whose focus handle is no longer focused (e.g. the input was removed from the tree while focused) is treated as `None`.

```APIDOC
## focused_input(&mut self, cx: &mut App) -> Option<AnyInputState>

### Description
Return the currently focused input state. Covers `Input`, `Textarea`, `Editor` and `OtpInput`, use `AnyInputState::as_input` and friends to get the concrete state. A registration whose focus handle is no longer focused (e.g. the input was removed from the tree while focused) is treated as `None`.

### Method
Trait method

### Signature
```rust
fn focused_input(&mut self, cx: &mut App) -> Option<AnyInputState>
```

### Parameters
- **cx** (&mut App) - Required - The application context.

### Returns
- **Option<AnyInputState>** - The currently focused input state, or `None` if no input is focused.
```

--------------------------------

### init

Source: https://docs.rs/gpui-component/latest/gpui_component/fn.init.html

Initializes the gpui-component library. Must be called at the application's entry point.

```APIDOC
## init

### Description
Initializes the gpui-component library. This function must be called at the application's entry point before using any components.

### Function Signature
```rust
pub fn init(cx: &mut App)
```

### Parameters
- **cx** (`&mut App`) - Required - The application context used for initialization.

### Usage
Call this function once at the start of your application to set up the component library.

### Example
```rust
use gpui_component::init;

fn main() {
    // ...
    init(&mut app);
}
```
```

--------------------------------

### Slice Rope

Source: https://docs.rs/gpui-component/latest/gpui_component/input/struct.Rope.html

Gets an immutable slice of the Rope using range syntax. Runs in O(log N) time. Panics if range start is greater than end, end is out of bounds, or ends are not on char boundaries.

```rust
let rope = Rope::from_str("Hello world!");
let slice = rope.slice(..5);

assert_eq!("Hello", slice);
```

--------------------------------

### Rc::get_mut_unchecked basic example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Shows how to use the nightly-only Rc::get_mut_unchecked to get a mutable reference without checks. Requires the get_mut_unchecked feature. Safety: if other Rc or Weak pointers exist, they must not be dereferenced or have active borrows during the returned borrow.

```rust
#![feature(get_mut_unchecked)]

use std::rc::Rc;

let mut x = Rc::new(String::new());
unsafe {
    Rc::get_mut_unchecked(&mut x).push_str("foo")
}
assert_eq!(*x, "foo");
```

--------------------------------

### Pie::new

Source: https://docs.rs/gpui-component/latest/gpui_component/plot/shape/struct.Pie.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new Pie instance.

```APIDOC
## Pie::new

### Description
Creates a new `Pie<T>` instance.

### Method
`pub fn new() -> Pie<T>`

### Parameters
None.

### Returns
- `Pie<T>` - A new `Pie` instance.

```

--------------------------------

### lines_len example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/trait.RopeExt.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example for lines_len. It returns the number of lines in the rope.

```rust
use gpui_base::input::{Rope, RopeExt};
let rope = Rope::from("Hello\nWorld\r\nThis is a test 中文\nRope");
assert_eq!(rope.lines_len(), 4);
```

--------------------------------

### Command palette usage example

Source: https://docs.rs/gpui-component/latest/gpui_component/command/struct.Command.html

Creates a CommandState and a Command with a group of items and a placeholder. The example shows how to set up a command palette with a labeled group and a search placeholder.

```rust
let state = cx.new(|cx| CommandState::new(window, cx));

Command::new(&state)
    .group(
        CommandGroup::new().label("Suggestions")
            .item(CommandItem::new().label("Calendar").icon(IconName::Calendar)),
    )
    .placeholder("Type a command or search...")
```

--------------------------------

### new

Source: https://docs.rs/gpui-component/latest/gpui_component/setting/struct.Settings.html

Creates a new Settings instance with a given ID.

```APIDOC
## pub fn new(id: impl Into<ElementId>) -> Self

### Description
Creates a new `Settings` instance with the given ID.

### Method
`new`

### Parameters
- **id** (`impl Into<ElementId>`) - Required - The ID for the settings instance.

### Returns
- `Self` - A new `Settings` instance.
```

--------------------------------

### Rc::into_raw example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Example of consuming an Rc and returning a raw pointer.

```rust
use std::rc::Rc;

let x = Rc::new("hello".to_owned());
let x_ptr = Rc::into_raw(x);
assert_eq!(unsafe { &*x_ptr }, "hello");
```

--------------------------------

### row_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/empty/struct.EmptyHeader.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Sets the row start of this element.

```APIDOC
## row_start(self, start: i16) -> Self

### Description
Sets the row start of this element.

### Method
fn row_start(self, start: i16) -> Self

### Parameters
- **start** (i16) - Required - The row start position.

### Returns
- **Self** - The updated EmptyHeader instance for chaining.
```

--------------------------------

### init

Source: https://docs.rs/gpui-component/latest/gpui_component/fn.init.html?search=u32+-%3E+bool

Initializes the gpui-component library. Must be called at the application's entry point before using any components.

```APIDOC
## init

### Description
Initializes the components. Must be called at the application's entry point.

### Signature
```rust
pub fn init(cx: &mut App)
```

### Parameters
- **cx** (`&mut App`) - Required - The application context.

### Returns
- `()` - No return value.
```

--------------------------------

### List source example

Source: https://docs.rs/gpui-component/latest/gpui_component/text/markdown_ast/struct.List.html?search=u32+-%3E+bool

Example showing the source representation of a list item with a marker.

```text
> | * a
    ^^^
```

--------------------------------

### pub fn show(&mut self, window: &mut Window, cx: &mut Context<'_, PopoverState>)

Source: https://docs.rs/gpui-component/latest/gpui_component/popover/struct.PopoverState.html?search=

Shows the popover, opening it and capturing focus.

```APIDOC
## pub fn show(&mut self, window: &mut Window, cx: &mut Context<'_, PopoverState>)

### Description
Shows the popover, opening it and capturing focus.

### Method
Action

### Parameters
- **self** (&mut self) - Required - The PopoverState instance.
- **window** (&mut Window) - Required - The window context.
- **cx** (&mut Context<'_, PopoverState>) - Required - The context for the PopoverState.
```

--------------------------------

### Install DockSkin on DockArea

Source: https://docs.rs/gpui-component/latest/gpui_component/dock/struct.DockSkin.html

Shows how to create a DockSkin and install it on a DockArea using with_renderer. The skin is created with DockSkin::new(cx) and passed to DockArea::new.

```rust
let skin = DockSkin::new(cx);
DockArea::new("main", None, window, cx).with_renderer(skin)
```

--------------------------------

### Rc::increment_strong_count example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Example of incrementing the strong reference count on an Rc pointer.

```rust
use std::rc::Rc;

let five = Rc::new(5);

unsafe {
    let ptr = Rc::into_raw(five);
    Rc::increment_strong_count(ptr);

    let five = Rc::from_raw(ptr);
    assert_eq!(2, Rc::strong_count(&five));
}
```

--------------------------------

### Rc::clone_from_ref example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Example of using Rc::clone_from_ref to clone a reference-counted value.

```rust
#![feature(clone_from_ref)]
use std::rc::Rc;

let hello: Rc<str> = Rc::clone_from_ref("hello");
```

--------------------------------

### Create a NativeMenu with items and show it

Source: https://docs.rs/gpui-component/latest/gpui_component/native_menu/index.html

Builds a `NativeMenu` with menu items for Copy, Paste, and Delete, separated by a separator, and shows it at a given position. The menu is rendered by the OS and can extend beyond the window. The `show` method takes a position, window, and context.

```rust
use gpui_kit::component::native_menu::NativeMenu;

NativeMenu::new()
    .menu("Copy", Box::new(Copy))
    .menu("Paste", Box::new(Paste))
    .separator()
    .menu("Delete", Box::new(Delete))
    .show(position, window, cx);
```

--------------------------------

### Root::new

Source: https://docs.rs/gpui-component/latest/gpui_component/struct.Root.html

Creates a new Root instance with the given view, window, and context.

```APIDOC
## new

### Description
Creates a new Root instance with the given view, window, and context.

### Method
new

### Signature
pub fn new(view: impl Into<AnyView>, window: &mut Window, cx: &mut Context<'_, Root>) -> Root

### Parameters
- `view` (impl Into<AnyView>) - Required - The content view to be hosted.
- `window` (&mut Window) - Required - The window in which the root is created.
- `cx` (&mut Context<'_, Root>) - Required - The context for the root.

### Returns
- `Root` - The newly created Root instance.
```

--------------------------------

### fn row_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/tab/struct.TabBar.html

Sets the row start of this element.

```APIDOC
## fn row_start(self, start: i16) -> Self

### Description
Sets the row start of this element.

### Parameters
- **start** (i16) - Required - The row start value.

### Returns
- **Self** - The element with the row start applied.
```

--------------------------------

### NativeMenu::new

Source: https://docs.rs/gpui-component/latest/gpui_component/native_menu/index.html

Creates a new NativeMenu instance. The example shows chaining menu items, a separator, and calling show to display the menu.

```APIDOC
## NativeMenu::new

### Description
Creates a new `NativeMenu` instance. The example shows chaining menu items, a separator, and calling `show` to display the menu.

### Method
Constructor

### Syntax
```rust
NativeMenu::new()
```

### Parameters
None

### Returns
A new `NativeMenu` instance.

### Example
```rust
use gpui_kit::component::native_menu::NativeMenu;

NativeMenu::new()
    .menu("Copy", Box::new(Copy))
    .menu("Paste", Box::new(Paste))
    .separator()
    .menu("Delete", Box::new(Delete))
    .show(position, window, cx);
```

```

--------------------------------

### fn row_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/tab/struct.TabBar.html?search=std%3A%3Avec

Sets the row start of this element.

```APIDOC
## fn row_start(self, start: i16) -> Self

### Description
Sets the row start of this element.

### Signature
`fn row_start(self, start: i16) -> Self`

### Parameters
- **start** (i16) - Required - The row start position.
```

--------------------------------

### fn col_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/list/struct.ListItem.html

Sets the column start of this element.

```APIDOC
## fn col_start(self, start: i16) -> Self

### Description
Sets the column start of this element.

### Method
fn col_start(self, start: i16) -> Self

### Parameters
- **self** - The element to modify.
- **start** (i16) - The column start position.

### Returns
- **Self** - The modified element.
```

--------------------------------

### Opacity method example

Source: https://docs.rs/gpui-component/latest/gpui_component/theme/struct.ThemeToken.html?search=

Shows how to use the opacity method to multiply the alpha value of a color by a factor, returning a new HSLA color.

```rust
let color = gpui::red();
let faded_color = color.opacity(0.5);
assert_eq!(faded_color.a, 0.5);
```

--------------------------------

### init

Source: https://docs.rs/gpui-component/latest/gpui_component/button/struct.ButtonGroup.html

Method to initialize a pointer.

```APIDOC
## init

### Description
Initializes a with the given initializer. This method is part of the `Pointable` trait.

### Method
init

### Parameters
- **init** (`<T as Pointable>::Init`) - Required - The initializer.

### Returns
- `usize` - The pointer address.
```

--------------------------------

### fn row_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/combobox/struct.Combobox.html?search=

Sets the row start of this element.

```APIDOC
## fn row_start(self, start: i16) -> Self

### Description
Sets the row start of this element.

### Method
fn

### Signature
`fn row_start(self, start: i16) -> Self`

### Parameters
- **start** (i16) - Required - The row start position.

### Returns
- **Self** - The updated element for chaining.
```

--------------------------------

### fn col_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/alert/struct.Alert.html

Sets the column start of this element.

```APIDOC
## fn col_start(self, start: i16) -> Self

### Description
Sets the column start of this element.

### Method
col_start

### Parameters
- **start** (i16) - Required - The column start position.

### Returns
Self - The element with the column start set.
```

--------------------------------

### NativeMenu::new

Source: https://docs.rs/gpui-component/latest/gpui_component/native_menu/index.html?search=

Creates a new NativeMenu instance.

```APIDOC
## NativeMenu::new

### Description
Creates a new `NativeMenu` instance that will be rendered by the operating system.

### Method
`NativeMenu::new()`

### Parameters
None.

### Returns
A new `NativeMenu` instance.

### Example
```rust
use gpui_kit::component::native_menu::NativeMenu;

let menu = NativeMenu::new();
```
```

--------------------------------

### Rc::from_raw example

Source: https://docs.rs/gpui-component/latest/gpui_component/input/type.InputHighlighterFactory.html

Example of converting a raw pointer back to an Rc, with safety notes.

```rust
use std::rc::Rc;

let x = Rc::new("hello".to_owned());
let x_ptr = Rc::into_raw(x);

unsafe {
    // Convert back to an `Rc` to prevent leak.
    let x = Rc::from_raw(x_ptr);
    assert_eq!(&*x, "hello");

    // Further calls to `Rc::from_raw(x_ptr)` would be memory-unsafe.
}

// The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
```

--------------------------------

### StatusBar::new

Source: https://docs.rs/gpui-component/latest/gpui_component/status_bar/struct.StatusBar.html

Creates a new, empty StatusBar instance.

```APIDOC
## StatusBar::new

### Description
Creates a new, empty `StatusBar`.

### Method
`pub fn new() -> Self`

### Parameters
None.

### Returns
A new `StatusBar` instance.

### Example
```rust
use gpui_kit::component::status_bar::StatusBar;

let status_bar = StatusBar::new();
```
```

--------------------------------

### Icon Constructors and Configuration Methods

Source: https://docs.rs/gpui-component/latest/gpui_component/struct.Icon.html?search=

Methods for constructing and configuring an `Icon` instance in the gpui-component library.

```APIDOC
## Icon::new

### Description
Creates a new `Icon` instance from any value that can be converted into an `Icon`.

### Method
`pub fn new(icon: impl Into<Icon>) -> Self`

### Parameters
- **icon** (`impl Into<Icon>`) - Required - The value to convert into an `Icon`.

### Returns
- **Self** - A new `Icon` instance.
```

```APIDOC
## Icon::path

### Description
Sets the icon path of the Assets bundle. Replaces any previously set path or SVG data.

### Method
`pub fn path(self, path: impl Into<SharedString>) -> Self`

### Parameters
- **path** (`impl Into<SharedString>`) - Required - The icon path, for example `icons/foo.svg`.

### Returns
- **Self** - The `Icon` with the path set.
```

```APIDOC
## Icon::data

### Description
Sets raw SVG bytes without registering an asset path. Copies the bytes into shared storage; the input need not be static. Cloning the icon shares those bytes. Replaces any previously set path or data. Parsing and rendering follow GPUI's SVG behavior.

### Method
`pub fn data(self, data: &[u8]) -> Self`

### Parameters
- **data** (`&[u8]`) - Required - The raw SVG bytes.

### Returns
- **Self** - The `Icon` with the SVG data set.

### Example
```rust
use gpui_component::Icon;

let bytes = br#"<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
    <path d="M4 12h16" stroke="currentColor"/>
</svg>"#;
let icon = Icon::default().data(bytes);
```
```

```APIDOC
## Icon::view

### Description
Creates a new view for the icon.

### Method
`pub fn view(self, cx: &mut App) -> Entity<Icon>`

### Parameters
- **cx** (`&mut App`) - Required - The application context.

### Returns
- **Entity<Icon>** - A new view entity for the icon.
```

```APIDOC
## Icon::transform

### Description
Sets the SVG transformation, replacing any previous transformation or rotation.

### Method
`pub fn transform(self, transformation: Transformation) -> Self`

### Parameters
- **transformation** (`Transformation`) - Required - The SVG transformation to apply.

### Returns
- **Self** - The `Icon` with the transformation set.
```

```APIDOC
## Icon::empty

### Description
Creates an empty `Icon`.

### Method
`pub fn empty() -> Self`

### Returns
- **Self** - An empty `Icon` instance.
```

```APIDOC
## Icon::rotate

### Description
Rotates the icon by the given angle. Replaces any previous transformation or rotation.

### Method
`pub fn rotate(self, radians: impl Into<Radians>) -> Self`

### Parameters
- **radians** (`impl Into<Radians>`) - Required - The rotation angle in radians.

### Returns
- **Self** - The `Icon` with the rotation applied.
```

--------------------------------

### EffectTransition usage example

Source: https://docs.rs/gpui-component/latest/gpui_component/animation/struct.EffectTransition.html

Example usage of EffectTransition to apply a fade and slide effect to an element.

```rust
EffectTransition::new(Duration::from_millis(150))
    .ease(ease_out_cubic)
    .slide_y(px(-4.), px(0.))
    .fade(0.0, 1.0)
    .apply(element, "enter-anim")
```

--------------------------------

### open_dialog<F>(&mut self, cx: &mut App, build: F)

Source: https://docs.rs/gpui-component/latest/gpui_component/trait.WindowExt.html

Opens a Dialog.

```APIDOC
## open_dialog<F>(&mut self, cx: &mut App, build: F)

### Description
Opens a Dialog.

### Method
Trait method

### Signature
```rust
fn open_dialog<F>(&mut self, cx: &mut App, build: F)
where
    F: Fn(Dialog, &mut Window, &mut App) -> Dialog + 'static,
```

### Parameters
- **cx** (&mut App) - Required - The application context.
- **build** (F) - Required - A closure that receives a Dialog, a mutable Window, and a mutable App, and returns a Dialog.

### Returns
None
```

--------------------------------

### fn row_start(self, start: i16) -> Self

Source: https://docs.rs/gpui-component/latest/gpui_component/button/struct.Toggle.html

Sets the row start position for the element.

```APIDOC
## fn row_start(self, start: i16) -> Self

### Description
Sets the row start of this element.

### Method
fn row_start(self, start: i16) -> Self

### Parameters
- **start** (i16) - The row start position.

### Returns
Self - The modified element.
```

--------------------------------

### ToggleZoom::documentation

Source: https://docs.rs/gpui-component/latest/gpui_component/dock/struct.ToggleZoom.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the documentation for this action, if any.

```APIDOC
## ToggleZoom::documentation

### Description
Returns the documentation for this action, if any.

### Method
fn documentation() -> Option<&'static str>

### Parameters
None

### Returns
- **Option<&'static str>** - The documentation string, if any.

```
Tokens:
Raw