tooltip

Tooltip widget builder. First child is the target, second is tooltip content.

Types

Opt

Option type for tooltip properties.

pub type Opt {
  Position(position.Position)
  Gap(Float)
  Padding(Float)
  SnapWithinViewport(Bool)
  Delay(Int)
  Style(String)
  A11y(a11y.A11y)
}

Constructors

```
Position(position.Position)
```
```
Gap(Float)
```
```
Padding(Float)
```
```
SnapWithinViewport(Bool)
```
```
Delay(Int)
```
```
Style(String)
```
```
A11y(a11y.A11y)
```

opaque </>

pub opaque type Tooltip

Values

</>

pub fn a11y(tt: Tooltip, a: a11y.A11y) -> Tooltip

Set accessibility properties for this widget.

build

</>

pub fn build(tt: Tooltip) -> node.Node

Build the tooltip into a renderable Node.

delay

</>

pub fn delay(tt: Tooltip, d: Int) -> Tooltip

Set the delay in milliseconds.

extend

</>

pub fn extend(tt: Tooltip, children: List(node.Node)) -> Tooltip

Add multiple child nodes.

gap

</>

pub fn gap(tt: Tooltip, g: Float) -> Tooltip

Set the gap between elements.

new

</>

pub fn new(id: String, tip: String) -> Tooltip

Create a new tooltip builder.

padding

</>

pub fn padding(tt: Tooltip, p: Float) -> Tooltip

Set the padding in pixels.

The renderer’s tooltip widget accepts a scalar thickness only; iced’s tooltip API has no per-side padding.

position

</>

pub fn position(tt: Tooltip, p: position.Position) -> Tooltip

Set the position.

push

</>

pub fn push(tt: Tooltip, child: node.Node) -> Tooltip

Add a child node.

snap_within_viewport

</>

pub fn snap_within_viewport(
  tt: Tooltip,
  enabled: Bool,
) -> Tooltip

Set whether the tooltip snaps to the viewport.

style

</>

pub fn style(tt: Tooltip, s: String) -> Tooltip

Set the style.

with_opts

</>

pub fn with_opts(tt: Tooltip, opts: List(Opt)) -> Tooltip

Apply a list of options to a tooltip builder.