Skip to main content

Module widgets

Module widgets 

Source
Expand description

GPUI widgets

Structs§

Checkbox
Checkbox widget
CheckboxGroup
Checkbox group widget for multi-selection
Collapsible
Collapsible section widget
ColorSwatch
Color swatch widget with hex input and color picker
ConfirmationDialog
Confirmation dialog widget
DirectoryPicker
Directory picker widget
Dropdown
Dropdown/Select widget
FilePicker
File picker widget
FocusNext
FocusPrev
NumberStepper
Number stepper widget with +/- buttons
PasswordInput
Password input widget with visibility toggle
ProgressBar
Progress bar widget
RadioGroup
Radio group widget for single-selection
RepeatableActivateButton
RepeatableDirectoryPicker
Repeatable directory picker widget
RepeatableFilePicker
Repeatable file picker widget
RepeatableTextInput
Repeatable text input widget
Scrollable
A scroll view with visible scrollbars
SegmentOption
A single option in the segmented control
SegmentedControl
Segmented control widget for single-selection from horizontal options
SidebarNav
Generic sidebar navigation widget
Slider
Slider widget for selecting numeric values
Spinner
Spinner widget
StringItem
A simple string-based selection item
TabBar
Generic tab bar widget
TextInput
Text input widget state
ToggleSwitch
Toggle switch widget
Tooltip
A simple tooltip view for displaying text messages

Enums§

CheckboxEvent
Events emitted by Checkbox
CheckboxGroupEvent
Events emitted by CheckboxGroup
CollapsibleEvent
Events emitted by Collapsible
ColorSwatchEvent
Events emitted by ColorSwatch
ConfirmationDialogEvent
Events emitted by ConfirmationDialog
DialogButton
Which button a key or action should trigger
DialogStyle
Dialog style/severity (controls primary button color)
DirectoryPickerEvent
Events emitted by DirectoryPicker
DirectoryPickerValidation
Validation state for DirectoryPicker
DirectoryValidationDisplay
Controls how validation feedback is displayed in file/directory pickers
DropdownEvent
Events emitted by Dropdown
FileMode
File picker modes
FilePickerEvent
Events emitted by FilePicker
FilePickerValidation
Validation state for FilePicker
LabelPosition
Position of the label relative to the toggle switch
MissingDirectories
How to handle missing parent directories
NumberStepperEvent
Events emitted by NumberStepper
PasswordInputEvent
Events emitted by PasswordInput
PickerMode
Color picker mode (RGB or HSL sliders)
ProgressBarEvent
Events emitted by ProgressBar
RadioGroupEvent
Events emitted by RadioGroup
RepeatableDirectoryPickerEvent
Events emitted by RepeatableDirectoryPicker
RepeatableFilePickerEvent
Events emitted by RepeatableFilePicker
RepeatableTextInputEvent
Events emitted by RepeatableTextInput
ScrollbarAxis
Axis options for scrollbar display
SegmentedControlEvent
Events emitted by SegmentedControl
SidebarNavEvent
Events emitted by SidebarNav
SliderEvent
Events emitted by Slider
SpinnerSize
Spinner size presets
TabBarEvent
Events emitted by TabBar
TextInputEvent
Events emitted by TextInput
ToggleSwitchEvent
Events emitted by ToggleSwitch
ValidationDisplay
Controls how validation feedback is displayed in file/directory pickers

Traits§

EnabledCursorExt
Extension trait for applying cursor styling based on enabled state.
SelectionItem
Trait for items that can be displayed in selection widgets

Functions§

danger_button
Create a danger button with the specified label
primary_button
Create a primary button with the specified label
register_all_keybindings
Register all widget keybindings
register_button_keybindings
Register key bindings for button components
register_color_swatch_keybindings
Register key bindings for color swatch components
register_directory_picker_keybindings
Register key bindings for directory picker
register_dropdown_keybindings
Register key bindings for dropdown components
register_file_picker_keybindings
Register key bindings for file picker
register_focus_navigation_keybindings
Register Tab and Shift+Tab key bindings for focus navigation.
register_repeatable_text_input_keybindings
Register key bindings for repeatable text input buttons
register_sidebar_nav_keybindings
Register key bindings for sidebar nav components
register_tab_bar_keybindings
Register key bindings for tab bar components
register_text_input_keybindings
Register key bindings for text input components
repeatable_add_button
Render a repeatable widget add button (plus icon).
repeatable_remove_button
Render a repeatable widget remove button (minus icon).
scrollable_both
Create a scrollable container with both axes
scrollable_horizontal
Create a horizontal scrollable container
scrollable_vertical
Create a vertical scrollable container
secondary_button
Create a secondary button with the specified label
validate_directory_path
Validate a directory path
validate_file_path
Validate a file path for the given mode and missing directories policy
with_focus_actions
Apply standard focus navigation actions (Tab / Shift+Tab) to an element.

Type Aliases§

SecretString
Secret string type.