Skip to main content

Module prelude

Module prelude 

Source

Macros§

impl_res_clone
A macro for implementing the Res trait for Clone types.
impl_res_simple
A macro for implementing the Res trait for simple Copy types.
include_style
A macro which parses CSS from a file at runtime in debug mode, and includes the file in the binary in release mode.
langid

Structs§

AccessContext
A context used for configuring the accessibility features of a view.
AccessNode
Wrapper around an accesskit node builder, a node id, and a list of children to be added to the node.
Accordion
A view which organizes content into expandable sections.
AccordionPair
Animation
An ID used to reference style animations stored in the style store.
AnimationBuilder
A builder for constructing animations.
Application
Creating a new application creates a root Window and a Context. Views declared within the closure passed to Application::new() are added to the context and rendered into the root window.
ArcTrack
Makes a knob that represents the current value with an arc
Avatar
An avatar view is used to visually represent a person or entity and can contain text, an icon, or an image.
AvatarGroup
The AvatarGroup view can be used to group a series of avatars together.
Badge
A Badge view for showing notifications, counts, or status information.
Binding
A binding view that observes a reactive [vizia_reactive] signal and rebuilds its contents whenever the signal value changes.
BoundingBox
Represents an axis-aligned bounding box.
Button
A simple push button with a contained view.
ButtonGroup
A view which represents a group of buttons.
Calendar
A control used to select a date.
Canvas
Canvas provides an interface for drawing, and how the drawing is clipped and transformed. Canvas contains a stack of Matrix and clip values.
Card
A container view used to group related content.
CardContent
The content section of a Card.
CardFooter
The footer section of a Card.
CardHeader
The header section of a Card.
Checkbox
A checkbox used to display and toggle a boolean state.
Chip
A visual indicator such as a tag.
Collapsible
A collapsible view that can be opened or closed to hide content.
ComboBox
A ComboBox view which combines a textbox with a list popup, allowing users to filter options by typing.
Context
The main storage and control object for a Vizia application.
ContextProxy
A bundle of data representing a snapshot of the context when a thread was spawned.
Divider
The Divider view provides a thin, unobtrusive line for visually separating views.
DrawContext
A context used when drawing a view.
Dropdown
A dropdown is used to display some state with the ability to open a popup with options to change that state.
Duration
A Duration type to represent a span of time, typically used for system timeouts.
Effect
Handle for a running effect. Construct effects with Effect::new.
Element
A basic element with no interactivity.
Entity
An entity is an identifier used to reference a view; to get/set properties in the context.
Environment
A model for system specific state which can be accessed by any model or view.
Event
A wrapper around a message, providing metadata on how the event travels through the view tree.
EventContext
A context used when handling events.
FontSize
A font size value.
FontVariation
FontWeight
A font weight value.
GeoChanged
Bitflag representing whether the bounds of a view has changed after relayout.
Grid
A view which arranges its children into a grid.
HStack
A view which arranges its children into a horizontal stack (row).
Handle
A handle to a view which has been built into the tree.
Image
A view which presents an image.
ImageId
An ID used to reference images in the resource manager.
Instant
A measurement of a monotonically nondecreasing clock. Opaque and useful only with Duration.
KeyChord
A key chord used inside of a Keymap.
KeyframeBuilder
A builder for constructing keyframes.
Keymap
A keymap that associates key chords with actions.
KeymapEntry
An entry inside of a Keymap.
Knob
A circular view which represents a value.
Label
A label used to display text.
LanguageIdentifier
LanguageIdentifier is a core struct representing a Unicode Language Identifier.
LineClamp
LinearGradient
LinearGradientBuilder
A builder for constructing linear gradients.
List
A view for creating a list of items from an iterable signal.
ListItem
A view which represents a selectable item within a list.
Localized
A type which formats a localized message with any number of named arguments.
Markdown
A view which parses and displays markdown as rich text.
Matrix
A 2D matrix.
Memo
A memoized derived value that only recomputes when one of its tracked dependencies changes, and only notifies dependents when its value changes.
Menu
A popup menu view used by submenus and context menus.
MenuBar
A view which represents a horizontal group of menus.
MenuButton
A view which represents a pressable item within a menu.
Modifiers
The state of the modifier keys.
Opacity
An opacity value in the range of 0 to 1.
Popover
A view for displaying popup content.
PopupData
A model which can be used by views which contain a popup.
Position
ProgressBar
A simple progress bar that can be used to show the progress of something.
RGBA
A color with red, green, blue, and alpha components, in a byte each.
RadioButton
A radio button used to display and toggle boolean state.
Rating
A view which represents a rating as a number of filled stars.
ReadSignal
A getter only Signal
Resizable
A view that can be resized by clicking and dragging from one of its edges.
ResizeHandle
Runtime
The internal reactive Runtime which stores all the reactive system states in a thread local.
Scale
A scale defining a scale value on the x and the y axis.
ScrollView
A container a view which allows the user to scroll any overflowed content.
Scrollbar
A view which represents a bar that can be dragged to manipulate a scrollview.
Select
A view which allows the user to select an item from a dropdown list.
Shadow
A box shadow adding a shadow effect around an element’s frame.
ShadowBuilder
A builder for constructing a shadow.
Sidebar
A sidebar container with optional header, scrollable content area, and optional footer.
Signal
A local (UI-thread) read write Signal.
Slider
The slider control can be used to select from a continuous set of values.
Spacer
A view which can be used to add stretch space between two other views.
Spinbox
A view which represents a value which can be incremented or decremented.
Style
Stores the style properties of all entities in the application.
Submenu
A view which represents a submenu within a menu.
Svg
A view which presents an SVG image.
Switch
A Switch used to display and toggle a boolean state.
SyncDerivedSignal
A derived signal backed by a thread-safe Signal.
SyncReadSignal
SyncSignal
A thread-safe read-write signal.
SyncWriteSignal
TabHeader
TabPair
TabView
Table
A table-like view backed by List for variable row heights.
TableColumn
Describes a table column.
TableHeader
Reusable helpers for building table header content.
TableSortState
Externally controlled sort state for a table.
TextDecorationLine
TextSpan
A view which represents a span of text within a label.
TextStroke
Textbox
The Textbox view provides an input control for editing a value as a string.
TickKnob
Makes a round knob with a tick to show the current value
Ticks
Adds tickmarks to a knob to show the steps that a knob can be set to. When added to a knob, the knob should be made smaller (depending on span), so the knob doesn’t overlap with the tick marks
Timer
A handle used to start, stop, and check the running status of a timer added with cx.add_timer().
ToggleButton
A button which can be toggled between two states.
Tooltip
A tooltip view.
Transition
Defines a transition that allows to change property values smoothly, over a given duration.
Translate
A translate defining a translate value on the x and the y axis.
Tree
The Tree describes the tree of entities.
UpdaterEffect
Internal updater effect handle. Prefer the associated constructors over the free functions.
VStack
A view which arranges its children into a vertical stack (column).
VirtualList
A view for creating a list of items from a binding to an iteratable list. Rather than creating a view for each item, items are recycled in the list.
VirtualTable
A virtualized table view backed by VirtualList for large datasets.
Window
WindowButtons
WindowPosition
The logical position of a window in screen coordinates.
WindowSize
The logical size of an application window.
WindowState
WriteSignal
A setter only Signal
XYPad
A view which allows the user to manipulate 2 floating point values simultaneously on a two dimensional pane.
ZStack
A view which overlays its children on top of each other.

Enums§

AccordionEvent
Action
An action to be taken on an accessibility node.
Alignment
Anchor
AnchorTarget
Angle
A value representing an angle expressed in degrees, gradians, radians, or turns.
ApplicationError
AvatarVariant
Enum which represents the geometric variants of an avatar view.
BackgroundImage
BackgroundSize
BadgePlacement
Enum which represents the placement of a badge on its parent.
BorderStyleKeyword
The keyword of a single border style.
ButtonVariant
Used in conjunction with the variant modifier for selecting the style variant of a button or button group.
CalendarEvent
ChipVariant
Used in conjunction with the variant modifier for selecting the style variant of a chip.
ClipPath
Code
Code is the physical position of a key.
CollapsibleEvent
Events that can be triggered by the collapsible view.
Color
A color value.
ControlSize
Enum representing semantic size presets for common controls.
CornerShape
The shape the default view drawing algorithm should use for handling borders.
CssRule
CursorIcon
An icon of a cursor.
Direction
Display
Determines whether an entity will be rendered and acted on by the layout system. To make an entity invisible to rendering but still visible to layout, see Visibility.
DropData
Data associated with a drop event.
EnvironmentEvent
Events for setting the state in the Environment.
FamilyOwned
A font-family.
Filter
FontFamily
FontSlant
FontWeightKeyword
A font weight keyword corresponding to a specific font weight.
FontWidth
A font stretch value.
GenericFontFamily
Gradient
HorizontalPositionKeyword
A horizontal position keyword.
ImageOrGradient
An enum which represents an image or a gradient.
ImageRetentionPolicy
An image should be stored in the resource manager.
Key
Key represents the meaning of a keypress.
KeymapEvent
An event used to interact with a Keymap at runtime.
KnobMode
LayoutType
The layout type determines how the nodes will position its parent-directed children.
LayoutWrap
Determines whether children wrap to a new line when they overflow the main axis.
Length
LengthOrPercentage
A length or a percentage value.
LengthValue
A length value.
LineDirection
ListEvent
Events used by the List view
Live
MenuEvent
Events used by menus.
MouseButton
A mouse button.
MouseButtonState
The state of a mouse button.
Orientation
The orientation of a widget, such as a slider or scrollbar
Overflow
Determines how to deal with content that overflows the bounding box of the element.
Placement
Describes the placement of a view relative to its parent element.
PointerEvents
Determines whether an entity will receive pointer events.
PopupEvent
Events used by the Popover view.
PositionType
The position type determines whether a node will be positioned in-line with its siblings or out-of-line / independently of its siblings.
Propagation
Determines how an event propagates through the tree.
ProxyEmitError
Errors that might occur when emitting an event via a ContextProxy.
ResizableEvent
Events emitted by the Resizable view to indicate changes in dragging state.
ResizeStackDirection
A direction for resizing a resizable stack from one of its edges.
Role
The type of an accessibility node.
ScrollEvent
Events for setting the properties of a scroll view.
Selectable
Represents how items can be selected in a list.
SpinboxIcons
And enum which represents the icons that can be used for the increment and decrement buttons of the Spinbox.
TabEvent
TableSortCycle
Controls how sortable columns cycle through sort directions when clicked.
TableSortDirection
Sort direction for a table column.
TextAlign
Determines how overflowed content that is not displayed should be signaled to the user.
TextDecorationStyle
TextEvent
Events for modifying a textbox.
TextOverflow
Determines how overflowed content that is not displayed should be signaled to the user.
TextStrokeStyle
ThemeMode
And enum which represents the current built-in theme mode.
TimerAction
Enum which can be used to determine the reason a timer callback was called.
Transform
An individual transform function.
Units
Units which describe spacing and size.
VerticalPositionKeyword
A vertical position keyword.
Visibility
Determines whether an entity will be rendered.
WindowEvent
Events generated by the application in response to OS events as well as events that can be used to set properties of the window.

Traits§

AbilityModifiers
Modifiers for changing the abilities of a view.
AccessibilityModifiers
Modifiers for changing the accessibility properties of a view.
ActionModifiers
Modifiers which add an action callback to a view.
AvatarModifiers
Modifiers for changing the appearance and content of an Avatar.
ButtonModifiers
Modifiers for changing the appearance of buttons.
ControlModifiers
Modifiers for common control-level behavior that can be shared across views.
DataContext
A trait for any Context-like object that lets you access stored model data.
EmitContext
A trait for any Context-like object that lets you emit events.
GenerationalId
A trait implemented by any generational id.
IntoCssStr
Helper trait for getting CSS from a string or path.
LayoutModifiers
Modifiers for changing the layout properties of a view.
ListModifiers
Modifiers for changing the behavior and selection state of a List.
Model
A trait implemented by application data in order to respond to events and mutate state.
ModifyWindow
PopoverModifiers
Modifiers for configuring Popover behavior and positioning.
Res
A trait which allows passing a value or reactive source to a view or modifier.
SignalGet
SignalMap
SignalRead
SignalTrack
SignalUpdate
SignalWith
SignalWrite
SliderModifiers
StyleModifiers
Modifiers for changing the style properties of a view.
TableModifiers
Modifiers for configuring controlled table state and callbacks.
TextModifiers
Modifiers for changing the text properties of a view.
ToStringLocalized
A trait for converting from Localized to a String via a translation using fluent.
TreeExt
Trait which provides methods for querying the tree.
View
A view is any object which can be displayed on the screen.
VirtualTableModifiers
Modifiers for configuring controlled virtual table state and callbacks.
WindowModifiers
Modifiers for setting the properties of a window.

Functions§

number_with_fraction
Helper function for formatting a number with decimal places for localized display.
percentage
Helper function for formatting a number as a percentage for localized display.

Type Aliases§

HorizontalPosition
VerticalPosition