Expand description
Use the built-in widgets or create your own.
Modules§
- button
- Buttons allow your users to perform actions by pressing them.
- canvas
canvas
- Canvases can be leveraged to draw interactive 2D graphics.
- checkbox
- Checkboxes can be used to let users make binary choices.
- combo_
box - Combo boxes display a dropdown list of searchable and selectable options.
- container
- Containers let you align a widget inside their boundaries.
- image
image
- Images display raster graphics in different formats (PNG, JPG, etc.).
- keyed
- Keyed widgets can provide hints to ensure continuity.
- markdown
markdown
- Markdown widgets can parse and display Markdown.
- overlay
- Display interactive elements on top of other widgets.
- pane_
grid - Pane grids let your users split regions of your application and organize layout dynamically.
- pick_
list - Pick lists display a dropdown list of selectable options.
- pop
- Generate messages when content pops in and out of view.
- progress_
bar - Progress bars visualize the progression of an extended computer operation, such as a download, file transfer, or installation.
- qr_code
qr_code
- QR codes display information in a type of two-dimensional matrix barcode.
- radio
- Radio buttons let users choose a single option from a bunch of options.
- rule
- Rules divide space horizontally or vertically.
- scrollable
- Scrollables let users navigate an endless amount of content with a scrollbar.
- shader
wgpu
- A custom shader widget for wgpu applications.
- slider
- Sliders let users set a value by moving an indicator.
- svg
svg
- Svg widgets display vector graphics in your application.
- text
- Draw and interact with text.
- text_
editor - Text editors display a multi-line text input for text editing.
- text_
input - Text inputs display fields that can be filled with text.
- theme
- Use the built-in theme and styles.
- toggler
- Togglers let users make binary choices by toggling a switch.
- tooltip
- Tooltips display a hint of information over some element when hovered.
- vertical_
slider - Sliders let users set a value by moving an indicator.
Macros§
- column
- Creates a
Column
with the given children. - keyed_
column - Creates a keyed
Column
with the given children. - rich_
text - Creates some
Rich
text with the given spans. - row
- Creates a
Row
with the given children. - stack
- Creates a
Stack
with the given children. - text
- Creates a new
Text
widget with the provided content.
Structs§
- Action
- A runtime action that can be performed by some widgets.
- Button
- A generic widget that produces a message when pressed.
- Canvas
- A widget capable of drawing 2D graphics.
- Checkbox
- A box that can be checked.
- Column
- A container that distributes its contents vertically.
- Combo
Box - A widget for searching and selecting a single value from a list of options.
- Container
- A widget that aligns its contents inside of its boundaries.
- Image
- A frame that displays an image while keeping aspect ratio.
- Lazy
lazy
- A widget that only rebuilds its contents when necessary.
- Mouse
Area - Emit messages on mouse events.
- Pane
Grid - A collection of panes distributed using either vertical or horizontal splits to completely fill the space available.
- Pick
List - A widget for selecting a single value from a list of options.
- Pin
- A widget that positions its contents at some fixed coordinates inside of its boundaries.
- Pop
- A widget that can generate messages when its content pops in and out of view.
- Progress
Bar - A bar that displays progress.
- QRCode
- A type of matrix barcode consisting of squares arranged in a grid which can be read by an imaging device, such as a camera.
- Radio
- A circular button representing a choice.
- Responsive
lazy
- A widget that is aware of its dimensions.
- Row
- A container that distributes its contents horizontally.
- Rule
- Display a horizontal or vertical rule for dividing content.
- Scrollable
- A widget that can vertically display an infinite amount of content with a scrollbar.
- Shader
- A widget which can render custom shaders with Iced’s
wgpu
backend. - Slider
- An horizontal bar and a handle that selects a single value from a range of values.
- Space
- An amount of empty space.
- Stack
- A container that displays children on top of each other.
- Svg
- A vector graphics image.
- Text
Editor - A multi-line text input.
- Text
Input - A field that can be filled with text.
- Themer
- A widget that applies any
Theme
to its contents. - Toggler
- A toggler widget.
- Tooltip
- An element to display a widget over another.
- Vertical
Slider - An vertical bar and a handle that selects a single value from a range of values.
Enums§
- Theme
- A built-in theme.
Traits§
- Component
Deprecated lazy
- A reusable, custom widget that uses The Elm Architecture.
Functions§
- bottom
- Creates a new
Container
that fills all the available space vertically and bottom-aligns its contents inside. - bottom_
center - Creates a new
Container
that fills all the available space and aligns its contents inside to the bottom center. - bottom_
right - Creates a new
Container
that fills all the available space and aligns its contents inside to the bottom right corner. - button
- Creates a new
Button
with the provided content. - canvas
canvas
- Creates a new
Canvas
. - center
- Creates a new
Container
that fills all the available space and centers its contents inside. - center_
x - Creates a new
Container
that fills all the available space horizontally and centers its contents inside. - center_
y - Creates a new
Container
that fills all the available space vertically and centers its contents inside. - checkbox
- Creates a new
Checkbox
. - column
- Creates a new
Column
with the given children. - combo_
box - Creates a new
ComboBox
. - component
Deprecated lazy
- Turns an implementor of
Component
into anElement
that can be embedded in any application. - container
- Creates a new
Container
with the provided content. - focus_
next - Focuses the next focusable widget.
- focus_
previous - Focuses the previous focusable widget.
- horizontal_
rule - Creates a horizontal
Rule
with the given height. - horizontal_
space - Creates a new
Space
widget that fills the available horizontal space. - hover
- Displays a widget on top of another one, only when the base widget is hovered.
- iced
svg
- Creates an
Element
that displays the iced logo with the giventext_size
. - image
image
- Creates a new
Image
. - keyed_
column - Creates a new
keyed::Column
from an iterator of elements. - lazy
lazy
- Creates a new
Lazy
widget with the given dataDependency
and a closure that can turn this data into a widget tree. - markdown
- Display a bunch of Markdown items.
- mouse_
area - A container intercepting mouse events.
- opaque
- Wraps the given widget and captures any mouse button presses inside the bounds of the widget—effectively making it opaque.
- pane_
grid - Creates a
PaneGrid
with the givenpane_grid::State
and view function. - pick_
list - Creates a new
PickList
. - pin
- Creates a new
Pin
widget with the given content. - pop
- Creates a new
Pop
widget. - progress_
bar - Creates a new
ProgressBar
. - qr_code
qr_code
- Creates a new
QRCode
widget from the givenData
. - radio
- Creates a new
Radio
. - responsive
lazy
- Creates a new
Responsive
widget with a closure that produces its contents. - rich_
text - Creates a new
Rich
text widget with the provided spans. - right
- Creates a new
Container
that fills all the available space horizontally and right-aligns its contents inside. - right_
center - Creates a new
Container
that fills all the available space and aligns its contents inside to the right center. - row
- Creates a new
Row
from an iterator. - scrollable
- Creates a new
Scrollable
with the provided content. - shader
wgpu
- Creates a new
Shader
. - slider
- Creates a new
Slider
. - span
- Creates a new
Span
of text with the provided content. - stack
- Creates a new
Stack
with the given children. - svg
svg
- Creates a new
Svg
widget from the givenHandle
. - text
- Creates a new
Text
widget with the provided content. - text_
editor - Creates a new
TextEditor
. - text_
input - Creates a new
TextInput
. - themer
- A widget that applies any
Theme
to its contents. - toggler
- Creates a new
Toggler
. - tooltip
- Creates a new
Tooltip
for the provided content with the givenElement
andtooltip::Position
. - value
- Creates a new
Text
widget that displays the provided value. - vertical_
rule - Creates a vertical
Rule
with the given width. - vertical_
slider - Creates a new
VerticalSlider
. - vertical_
space - Creates a new
Space
widget that fills the available vertical space.