Skip to content

StardewUI.Widgets Namespace

Classes

Name Description
Banner Draws banner-style text with an optional background.
Button Simple button with optional hover background.
CheckBox A togglable checkbox.
ColorPicker Drop-down style widget that opens a detailed color wheel/slider overlay for choosing a precise color.
ComponentView Base class for custom widgets and "app views" with potentially complex hierarchy using a single root view.
ComponentView<T> Base class for custom widgets and "app views" with potentially complex hierarchy using a single root view.
DecoratorView A view that owns and delegates to an inner view.
DecoratorView<T> A view that owns and delegates to an inner view.
DecoratorView<T>.DecoratedProperty<T, TValue> Helper for propagating a single property to and from the inner view.
DropDownList<T> Button/text field with a drop-down menu.
Expander A widget that can be clicked to expand/collapse with additional content.
FormBuilder Fluent builder style API for creating form-like tables within a view.
Frame A view that holds another view, typically for the purpose of adding a border or background, or in some cases swapping out the content.
GhostView A view that draws an exact copy of another view, generally with a tint and transparency to indicate that it is not the original view. Can be used for dragging, indicating target snap positions, etc.
Grid A uniform grid containing other views.
GridItemLayout Describes the layout of all items in a Grid.
GridItemLayout.Count A GridItemLayout specifying the maximum divisions - rows or columns, depending on the grid's Orientation; items will be sized distributed uniformly along that axis.
GridItemLayout.Length A GridItemLayout specifying that each item is to have the same fixed length (width or height, depending on the grid's Orientation) and to wrap to the next row/column afterward.
Image A view that draws a sprite, scaled to the layout size.
Label A view that renders a read-only text string.
Lane Simple unidirectional layout that draws multiple child views in a row or column arrangement.
Marquee A scrolling marquee supporting any inner content.
NineGridPlacementEditor Editor widget for a NineGridPlacement, which brings up a PositioningOverlay on click.
OutletAttribute Marks a child/children property as a named outlet.
Panel A layout view whose children all overlap the same boundaries.
PositioningOverlay An overlay that can be used to edit the position of some arbitrary content.
PositioningOverlay.ControlScheme Configures the mapping of buttons to positioning actions in a PositioningOverlay.
PositioningOverlay.GamepadControlScheme Configures the mapping of buttons to positioning actions in a PositioningOverlay. Includes the generic ControlScheme settings as well as grid-movement settings specific to gamepads.
ScrollableFrameView Layout widget for a sectioned menu including a scrollable content area.
ScrollableView Provides a content container and accompanying scrollbar.
Scrollbar Controls the scrolling of a ScrollContainer.
ScrollContainer Renders inner content clipped to a boundary and with a modifiable scroll offset.
SegmentedControl A horizontal list of options that can each be independently clicked and selected.
SelectionGroup Provides a single selection key with change notifications.
Slider A horizontal track with draggable thumb (button) for choosing a numeric value in a range.
Spacer An empty view whose sole purpose is to separate other elements.
Tab A view with tab appearance, used to navigate sections of a larger complex menu.
TextInput A text input field that allows typing from a physical or virtual keyboard.
TinyNumberLabel Renders a single-line numeric label using custom digit sprites.

Enums

Name Description
ImageFit Specifies how an image should be scaled to fit the content area when the available size is different from the image size, and especially when it has a different aspect ratio.
ShadowLayers Describes which shadow layers will be drawn, for widgets such as Label that support layered shadows.