StardewUI

https://focustense.github.io/StardewUI/
Admin
StardewUI is a UI framework for Stardew Valley mods that provides dynamic layout, retained-mode...
Tokens:307,151
Snippets:3,535
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### StardewUI Quick Start: ModEntry, MenuData, and ScrollingItemGrid.sml

Source: https://focustense.github.io/StardewUI

The C# files define the mod entry point and menu data for a StardewUI example. ModEntry registers views and creates a menu on F8; MenuData provides a list of edible items. The XML defines the menu layout with a banner, frame, scrollable grid, and repeating images.

```csharp
internal sealed class ModEntry : Mod
{
    private IViewEngine viewEngine;

    public override void Entry(IModHelper helper)
    {
        helper.Events.GameLoop.GameLaunched += GameLoop_GameLaunched;
        helper.Events.Input.ButtonPressed += Input_ButtonPressed;
    }

    private void GameLoop_GameLaunched(object? sender, GameLaunchedEventArgs e)
    {
        viewEngine = Helper.ModRegistry.GetApi<IViewEngine>("focustense.StardewUI");
        viewEngine.RegisterViews("Mods/TestMod/Views", "assets/views");
        viewEngine.EnableHotReloading();
    }

    private void Input_ButtonPressed(object? sender, ButtonPressedEventArgs e)
    {
        if (Context.IsPlayerFree && e.Button == SButton.F8)
        {
            var context = MenuData.Edibles();
            Game1.activeClickableMenu = viewEngine.CreateMenuFromAsset(
                "Mods/TestMod/Views/ScrollingItemGrid",
                context);
        }
    }
}

```

```csharp
public class MenuData
{
    public string HeaderText { get; set; } = "";
    public List<ParsedItemData> Items { get; set; } = [];

    public static MenuData Edibles()
    {
        int[] edibleCategories = [
            StardewValley.Object.CookingCategory,
            StardewValley.Object.EggCategory,
            StardewValley.Object.FishCategory,
            StardewValley.Object.FruitsCategory,
            StardewValley.Object.meatCategory,
            StardewValley.Object.MilkCategory,
            StardewValley.Object.VegetableCategory,
        ];
        var items = ItemRegistry.ItemTypes
            .Single(type => type.Identifier == ItemRegistry.type_object)
            .GetAllIds()
            .Select(id => ItemRegistry.GetDataOrErrorItem(id))
            .Where(data => edibleCategories.Contains(data.Category))
            .ToList();
        return new()
        {
            HeaderText = "All Edibles",
            Items = items,
        };
    }
}

```

```xml
<lane orientation="vertical"
      horizontal-content-alignment="middle">
    <banner background={@Mods/StardewUI/Sprites/BannerBackground}
            background-border-thickness="48,0"
            padding="12"
            text={HeaderText} />
    <frame layout="880px 640px"
           background={@Mods/StardewUI/Sprites/ControlBorder}
           margin="0,16,0,0"
           padding="32,24">
        <scrollable>
            <grid layout="stretch content"
                  item-layout="length: 64"
                  item-spacing="16,16"
                  horizontal-item-alignment="middle">
                <image layout="stretch content"
                       *repeat={Items}
                       sprite={this}
                       focusable="true" />
            </grid>
        </scrollable>
    </frame>
</lane>

```

--------------------------------

### Start(V, V, TimeSpan?) Method

Source: https://focustense.github.io/StardewUI/reference/stardewui/animation/animator-2

Method to start an animation with explicit start and end values.

```APIDOC
## Start(V, V, TimeSpan?) Method

### Description
Starts a new animation using the specified start/end values and duration.

### Signature
```csharp
public void Start(V startValue, V endValue, System.TimeSpan? duration);
```

### Parameters
- **startValue** (V) - Required - The initial value of the animation property. This will take effect immediately, even if it is far away from the current value; i.e. it may cause "jumps".
- **endValue** (V) - Required - The final value to be reached once the duration ends.
- **duration** (Nullable<TimeSpan>) - Optional - Duration of the animation; defaults to 1 second if not specified.
```

--------------------------------

### Minimal Example: ViewModels

Source: https://focustense.github.io/StardewUI/framework/included-views

View models for the minimal example. OuterViewModel contains an InnerViewModel property, and InnerViewModel has a Text property.

```csharp
public class OuterViewModel
{
    public InnerViewModel Inner { get; set; }
}

public class InnerViewModel
{
    public string Text { get; set; }
}
```

--------------------------------

### StarML basic frame example

Source: https://focustense.github.io/StardewUI/framework/starml

A basic StarML frame that demonstrates layout, data binding, and event handling. Use it as a starting point for UI screens: the frame sets a fixed size, background, border, and border thickness, while the lane stacks a label, a bound label, a text input bound to FarmerName, an image, and a button that invokes LaunchCoolFeature("now") on click.

```markup
<frame layout="850px 500px"
       background={@Mods/StardewUI/Sprites/MenuBackground}
       border={@Mods/StardewUI/Sprites/MenuBorder}
       border-thickness="36, 36, 40, 36">
    <lane layout="stretch content" orientation="vertical">
        <label font="dialogue" text="Hello from StardewUI!" />
        <label text={IntroParagraph} />
        <textinput layout="200px content" text={<>FarmerName} />
        <image layout="400px 100px" sprite={@Mods/TestMod/Sprites/Hello} />
        <button text="Launch" click=|LaunchCoolFeature("now")| />
    </lane>
</frame>
```

--------------------------------

### Start(Animation<V>) Method

Source: https://focustense.github.io/StardewUI/reference/stardewui/animation/animator-2

Method to start a new animation using an Animation<V> object.

```APIDOC
## Start(Animation<V>) Method

### Description
Starts a new animation with the given animation settings.

### Signature
```csharp
public void Start(StardewUI.Animation.Animation<V> animation);
```

### Parameters
- **animation** (Animation<V>) - Required - The animation settings.
```

--------------------------------

### Start(V, TimeSpan) Method

Source: https://focustense.github.io/StardewUI/reference/stardewui/animation/animator-2

Method to start an animation from the current value to a specified end value.

```APIDOC
## Start(V, TimeSpan) Method

### Description
Starts a new animation that begins at the current value and ends at the specified value after the specified duration.

### Signature
```csharp
public void Start(V endValue, System.TimeSpan duration);
```

### Parameters
- **endValue** (V) - Required - The final value to be reached once the duration ends.
- **duration** (TimeSpan) - Required - Duration of the animation; defaults to 1 second if not specified.
```

--------------------------------

### Placement property

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/ninegridplacement.neighbor

Gets or sets the neighboring placement.

```csharp
public StardewUI.Layout.NineGridPlacement Placement { get; set; }

```

--------------------------------

### TraceFile.CreationDate Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/diagnostics/tracefile

Gets the exact date and time when the trace was started.

```APIDOC
## TraceFile.CreationDate

### Description
Gets the exact date and time when the trace was started.

### Property Type
System.DateTime

### Access
Read-only

### Signature
```csharp
public System.DateTime CreationDate { get; }
```

```

--------------------------------

### C# - ModEntry with GetApi and ShowMenu

Source: https://focustense.github.io/StardewUI/framework/included-views

Entry point for the example mod. Contains the GetApi override and the ShowMenu method that constructs a MenuViewModel with built-in pages and custom pages from the API, then creates the menu from an asset.

```csharp
public class ModEntry : Mod
{
    // Preconditions and setup omitted; trigger the menu however you like.

    private IApi api;
    private ModConfig config; // E.g. loaded via Helper.ReadConfig
    private ModData data; // Can be any data/type, this is only an example.
    private IViewEngine viewEngine;

    public override object? GetApi()
    {
        return api;
    }

    public void ShowMenu()
    {
        var menuViewModel = new MenuViewModel([
            new()
            {
                Title = I18n.HomeTabTitle(),
                Icon = Tuple.Create(...),
                ContentViewName = "Mods/MyMod/Views/HomeMenuPage",
                ContentData = data
            },
            new()
            {
                Title = I18n.SettingsTabTitle(),
                Icon = Tuple.Create(...),
                ContentViewName = "Mods/MyMod/Views/SettingsMenuPage",
                ContentData = config
            },
            .. api.GetCustomPages()
        ]);
        Game1.activeClickableMenu = viewEngine.CreateMenuFromAsset(
            "Mods/MyMod/Views/MainMenu",
            menuViewModel
        );
    }
}
```

--------------------------------

### View Property Signature

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu

Gets the view to display with this menu.

```csharp
public StardewUI.IView View { get; }
```

--------------------------------

### Initialize(IModHelper, IMonitor)

Source: https://focustense.github.io/StardewUI/reference/stardewui/ui

Initializes the Stardew UI framework. Must be called from the Entry method of a mod with the helper and monitor.

```APIDOC
## Initialize(IModHelper, IMonitor)

### Description
Initialize the framework.

### Method
Initialize

### Signature
public static void Initialize(StardewModdingAPI.IModHelper helper, StardewModdingAPI.IMonitor monitor);

### Parameters
- **helper** (IModHelper) - Required - Helper for the calling mod.
- **monitor** (IMonitor) - Required - SMAPI logging helper.

```

--------------------------------

### CreationDate property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/diagnostics/tracefile

Gets the exact date and time when the trace was started. The property is read-only.

```csharp
public System.DateTime CreationDate { get; }

```

--------------------------------

### Get layout limits in OnMeasure

Source: https://focustense.github.io/StardewUI/library/custom-views

Starts almost every OnMeasure method. Translates the view's LayoutParameters into a pixel size representing the maximum available width and height.

```csharp
var limits = Layout.GetLimits(availableSize);

```

--------------------------------

### Basic Template Declaration and Usage

Source: https://focustense.github.io/StardewUI/framework/templates

Shows how to declare a template with the <template> element and use it by writing a tag with the same name, passing npc as an event argument.

```StarML
<lane orientation="vertical">
    <hello npc="Robin" />
    <hello npc="Sebastian" />
</lane>

<template name="hello">
    <lane>
        <image sprite={@Mods/MyMod/Sprites/UI:Wave} />
        <label text={&npc} />
    </lane>
</template>
```

--------------------------------

### TransformOrigin property (Microsoft.Xna.Framework.Vector2?)

Source: https://focustense.github.io/StardewUI/reference/stardewui/iview

Gets or sets the relative origin position for any Transform on this view. Expects a value representing the fraction of the view's computed layout size; for example, (0, 0) is top left, (0.5, 0.5) is center, and (1, 1) is bottom right. null values are equivalent to Zero. Origins are not inherited; each view defines its own origin for its specific transform.

```csharp
Microsoft.Xna.Framework.Vector2? TransformOrigin { get; set; }

```

--------------------------------

### TooltipData Constructor

Source: https://focustense.github.io/StardewUI/reference/stardewui/data/tooltipdata

Initializes a new instance of TooltipData with all tooltip fields. The Text parameter is the primary description, Title is bolded above Text, Item shows item-specific info, CurrencyAmount and CurrencySymbol handle money (0=coins, 1=star tokens, 2=casino tokens, 4=Qi gems), RequiredItemId/RequiredItemAmount for non-currency trades, and CraftingRecipe/AdditionalCraftingMaterials for craftable items.

```csharp
public TooltipData(string Text, string Title, StardewValley.Item Item, int? CurrencyAmount, int CurrencySymbol, string RequiredItemId, int RequiredItemAmount, StardewValley.CraftingRecipe CraftingRecipe, System.Collections.Generic.IList<StardewValley.Item> AdditionalCraftingMaterials);
```

--------------------------------

### ScrollWithChildren property (StardewUI.Layout.Orientation?)

Source: https://focustense.github.io/StardewUI/reference/stardewui/iview

Gets or sets an axis that specifies when any child of the view is scrolled into view (using ScrollIntoView(IEnumerable<ViewChild>, Vector2)), this entire view should be scrolled along with it. For example, if the view lays out children horizontally and some children are small near the top while others are taller or positioned near the bottom, configure with Vertical so the entire row is positioned within the scrollable viewport.

```csharp
StardewUI.Layout.Orientation? ScrollWithChildren { get; set; }

```

--------------------------------

### ViewEngine Constructor

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/api/viewengine

Initializes a new ViewEngine instance with the provided asset cache, SMAPI mod helper, and view node factory.

```APIDOC
## ViewEngine Constructor

### Description
Initializes a new ViewEngine instance.

### Method
Constructor

### Signature
`public ViewEngine(StardewUI.Framework.Content.IAssetCache assetCache, StardewModdingAPI.IModHelper helper, StardewUI.Framework.Binding.IViewNodeFactory viewNodeFactory)`

### Parameters
- **assetCache** (IAssetCache) - Required - Cache for obtaining document assets. Used for asset-based views.
- **helper** (IModHelper) - Required - SMAPI mod helper for the API consumer mod (not for StardewUI).
- **viewNodeFactory** (IViewNodeFactory) - Required - Factory for creating and binding IViewNodes.

```

--------------------------------

### Set up StardewUI API in C#

Source: https://focustense.github.io/StardewUI/getting-started

Add the API reference, declare a field for the IViewEngine, and obtain it in a GameLaunched handler. The using directive goes at the top of the file where the API is invoked, typically ModEntry.cs. The field is declared at class scope, and the API is retrieved via Helper.ModRegistry.GetApi<IViewEngine>("focustense.StardewUI").

```csharp
using StardewUI.Framework;

```

```csharp
private IViewEngine viewEngine;

```

```csharp
viewEngine = Helper.ModRegistry.GetApi<IViewEngine>("focustense.StardewUI");

```

--------------------------------

### Get(SButton)

Source: https://focustense.github.io/StardewUI/reference/stardewui/graphics/custombuttonspritemap

Gets the specific sprite for a particular button.

```APIDOC
## Method: Get(SButton)

### Description
Gets the specific sprite for a particular button.

### Signature
```csharp
protected override StardewUI.Graphics.Sprite Get(StardewModdingAPI.SButton button);
```

### Parameters
- **button** (SButton) - The button for which to retrieve a sprite.

### Returns
- **Sprite** - The precise Sprite representing the given `button`, or `null` if the button does not have a special sprite and could/should use a generic background + text.

```

--------------------------------

### Get<T>()

Source: https://focustense.github.io/StardewUI/reference/stardewui/tags

Gets the tag value of the specified type, if one exists.

```APIDOC
## Get<T>()

### Description
Gets the tag value of the specified type, if one exists.

### Method
Instance method

### Signature
```csharp
public T Get<T>();
```

### Parameters
None.

### Returns
`T` - The stored value of type `T`, if any; otherwise `null`.

```

--------------------------------

### populateClickableComponentList() method signature

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu-1

Always a no-op for menus in StardewUI.

```csharp
public override void populateClickableComponentList();
```

--------------------------------

### Get(Orientation, Vector2)

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/orientationextensions

Gets the component of a vector along the orientation's axis.

```APIDOC
## Get(Orientation, Vector2)

### Description
Gets the component of a vector along the orientation's axis.

### Method
Get(Orientation, Vector2)

### Parameters
- **orientation** (Orientation) - Required - The orientation.
- **vec** (Vector2) - Required - Any vector value.

### Returns
Single - The vector's X component if Horizontal, or Y if Vertical.

```

--------------------------------

### Simple(string, SpriteFont, Color?, int) factory method

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/label

Creates a typical, simple run of 1-line text using content sizing. The initialText is the text to display and can be updated later; font and color are optional and default to the label's defaults if null; margin adds horizontal spacing.

```csharp
public static StardewUI.Widgets.Label Simple(string initialText, Microsoft.Xna.Framework.Graphics.SpriteFont font, Microsoft.Xna.Framework.Color? color, int margin);
```

--------------------------------

### AssetValueSource<T>.CanRead Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/sources/assetvaluesource-1

Gets whether the source can be read from, indicating if getting the Value should succeed.

```APIDOC
## [PROPERTY] CanRead

### Description
Whether or not the source can be read from, i.e. if an attempt to get the Value should succeed.

### Declaration
`public bool CanRead { get; }`

### Property Value
Boolean

```

--------------------------------

### ViewEngine.CreateMenuControllerFromMarkup(string, Object)

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/api/viewengine

Creates a menu from arbitrary StarML markup and returns a controller for customizing its behavior.

```APIDOC
## ViewEngine.CreateMenuControllerFromMarkup(string, Object)

### Description
Creates a menu from arbitrary markup, and returns a controller for customizing the menu's behavior.

### Method
CreateMenuControllerFromMarkup

### Signature
`public StardewUI.Framework.IMenuController CreateMenuControllerFromMarkup(string markup, System.Object context)`

### Parameters
- **markup** (string) - Required - The markup in StarML format.
- **context** (Object) - Required - The context, or "model", for the menu's view, which holds any data-dependent values. **Note:** The type must implement INotifyPropertyChanged in order for any changes to this data to be automatically reflected in the UI.

### Returns
IMenuController - A controller object whose Menu is the created menu and whose other properties can be used to change menu-level behavior.

### Remarks
**Warning:** Ad-hoc menus created this way cannot be cached, nor patched by other mods. Most mods should not use this API except for testing/experimentation.

```

--------------------------------

### ViewMenu Constructor Signature

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu

Initializes a new instance of ViewMenu with a gutter and a flag to force default focus.

```csharp
public ViewMenu(StardewUI.Layout.Edges gutter, bool forceDefaultFocus);
```

--------------------------------

### ViewMenu(Edges, bool)

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu

Initializes a new instance of ViewMenu with the specified gutter edges and focus behavior.

```APIDOC
## ViewMenu(Edges, bool)

### Description
Initializes a new instance of ViewMenu.

### Method
Constructor

### Signature
`public ViewMenu(StardewUI.Layout.Edges gutter, bool forceDefaultFocus);`

### Parameters
- **gutter** (Edges) - Required - Gutter edges, in which no content should be drawn. Used for overscan, or general aesthetics.
- **forceDefaultFocus** (Boolean) - Required - Whether to always focus (snap the cursor to) the default element, even if the menu was triggered by keyboard/mouse.

```

--------------------------------

### Get(T, Boolean)

Source: https://focustense.github.io/StardewUI/reference/stardewui/graphics/ispritemap-1

Gets the sprite corresponding to a particular key. The method returns a Sprite and sets an out parameter indicating whether the sprite is a placeholder.

```APIDOC
## Get(T, Boolean)

### Description
Gets the sprite corresponding to a particular key.

### Method
Get(T key, out System.Boolean isPlaceholder)

### Parameters
- **key** (T) - The key to retrieve.
- **isPlaceholder** (System.Boolean) - `true` if the returned Sprite is not specific to the `key`, but is instead a placeholder (border/background) in which some substitute, typically normal text, must be drawn. `false` if the Sprite is a complete self-contained representation of the `key`.

### Returns
Sprite - The precise or generic sprite for the given `key`.
```

--------------------------------

### Get(SButton) method

Source: https://focustense.github.io/StardewUI/reference/stardewui/graphics/custombuttonspritemap

Gets the specific sprite for a given button. Returns null if the button does not have a special sprite and should use a generic background and text.

```csharp
protected override StardewUI.Graphics.Sprite Get(StardewModdingAPI.SButton button);

```

--------------------------------

### Simple(string, SpriteFont, Color?, int)

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/label

Creates a typical, simple run of 1-line text using content sizing.

```APIDOC
## Simple(string, SpriteFont, Color?, int)

### Description
Creates a typical, simple run of 1-line text using content sizing.

### Method
Simple(string, SpriteFont, Color?, int)

### Parameters
- **initialText** (string) - Required - Initial text to display; can be updated later.
- **font** (SpriteFont) - Required - Font to use, if different from the default label font.
- **color** (Nullable<Color>) - Required - Color to use, if different from the default font color.
- **margin** (Int32) - Required - Horizontal margin to add.

### Returns
Label
```

--------------------------------

### Transition(TimeSpan?, TimeSpan?, Easing)

Source: https://focustense.github.io/StardewUI/reference/stardewui/animation/transition

Constructor that initializes a Transition with optional duration, delay, and easing.

```APIDOC
## Transition(TimeSpan?, TimeSpan?, Easing)

### Description
Initializes a new Transition instance.

### Constructor
`public Transition(System.TimeSpan? duration, System.TimeSpan? delay, StardewUI.Animation.Easing easing);`

### Parameters
- **duration** (Nullable<TimeSpan>) - Duration of the transition. If not specified, the transition will use the DefaultDuration.
- **delay** (Nullable<TimeSpan>) - Delay during which to hold the current value before transitioning to the new value. If not specified, the transition will use the DefaultDelay.
- **easing** (Easing) - Type of easing or acceleration curve for the transition. If not specified, the transition will use the DefaultEasing.
```

--------------------------------

### Bounds.Size

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/bounds

Gets the width and height.

```APIDOC
## Property: Size

### Description
Gets the width and height.

### Type
Vector2
```

--------------------------------

### TraceFile Constructor

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/diagnostics/tracefile

Initializes a new instance of the TraceFile class.

```APIDOC
## TraceFile()

### Description
Initializes a new instance of the TraceFile class.

### Method
Constructor

### Signature
```csharp
public TraceFile();
```

```

--------------------------------

### Bounds.Position

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/bounds

Gets the top-left position.

```APIDOC
## Property: Position

### Description
Gets the top-left position.

### Type
Vector2
```

--------------------------------

### CreateView Method

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/checkbox

Creates and returns the root view as a Lane.

```csharp
protected override StardewUI.Widgets.Lane CreateView();
```

--------------------------------

### IMemberDescriptor.Name

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/descriptors/imemberdescriptor

Gets the member name.

```APIDOC
## IMemberDescriptor.Name

### Description
Gets the member name.

### Property
`string Name { get; }`

### Property Value
- **string** (System.String) - The member name.

```

--------------------------------

### CreateMenuControllerFromMarkup method signature

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/iviewengine

Creates a menu from arbitrary StarML markup and returns an IMenuController. The context must implement INotifyPropertyChanged for automatic UI updates. Warning: ad-hoc menus created this way cannot be cached or patched by other mods; use only for testing/experimentation.

```csharp
StardewUI.Framework.IMenuController CreateMenuControllerFromMarkup(string markup, System.Object context);
```

--------------------------------

### Visibility

Source: https://focustense.github.io/StardewUI/reference/stardewui/view

Gets or sets the visibility for this view.

```APIDOC
## Property: Visibility

### Description
Gets or sets the visibility for this view.

### Property Signature
```csharp
public StardewUI.Layout.Visibility Visibility { get; set; }
```

### Property Value
- **Type**: `StardewUI.Layout.Visibility`
- **Description**: The visibility state of the view.

```

--------------------------------

### View

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu

Gets the view to display with this menu.

```APIDOC
## View

### Description
The view to display with this menu.

### Property
`public StardewUI.IView View { get; }`

### Property Value
IView

```

--------------------------------

### Create a floating overlay with alignment

Source: https://focustense.github.io/StardewUI/library/overlays

Use Overlay.Push to display a view as a floating overlay. The example aligns the overlay's right edge with the parent's right edge and its top edge with the parent's bottom edge, using HorizontalAlignment.End, HorizontalParentAlignment.End, VerticalAlignment.Start, and VerticalParentAlignment.End. The parent can be 'this' when triggered from a View; omitting parent or setting it to null positions relative to the screen.

```csharp
Overlay.Push(
    new Overlay(
        overlayView,
        this, // Parent view; can specify "this" if triggered from a View.
        horizontalAlignment: Alignment.End,
        horizontalParentAlignment: Alignment.End,
        verticalAlignment: Alignment.Start,
        verticalParentAlignment: Alignment.End
    ));
```

--------------------------------

### Multiple Templates in One File

Source: https://focustense.github.io/StardewUI/framework/templates

Illustrates defining and using multiple templates in the same file.

```StarML
<lane orientation="vertical">
    <hello npc="Robin" />
    <goodbye npc="Sebastian" />
</lane>

<template name="hello">
    <lane>
        <image sprite={@Mods/MyMod/Sprites/UI:Wave} />
        <label text={&npc} />
    </lane>
</template>

<template name="goodbye">
    <lane>
        <image sprite={@Mods/MyMod/Sprites/UI:SadFace} />
        <label text={&npc} />
    </lane>
</template>
```

--------------------------------

### Top

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/edges

Gets or sets the top edge.

```APIDOC
## Top

### Description
The top edge.

### Property
`public int Top { get; set; }`
```

--------------------------------

### Right

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/edges

Gets or sets the right edge.

```APIDOC
## Right

### Description
The right edge.

### Property
`public int Right { get; set; }`
```

--------------------------------

### CreateView method

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/button

Creates and returns the root view for the button.

```csharp
protected override StardewUI.View CreateView();
```

--------------------------------

### PreloadAssets()

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/api/viewengine

Begins preloading assets found in this mod's registered asset directories.

```APIDOC
## PreloadAssets()

### Description
Begins preloading assets found in this mod's registered asset directories.

### Method
PreloadAssets

### Signature
`public void PreloadAssets();`

### Remarks
Preloading is performed in the background, and can typically help reduce first-time latency for showing menus or drawables, without any noticeable lag in game startup. 
Must be called after asset registration (RegisterViews(string, string), RegisterSprites(string, string) and so on) in order to be effective, and must not be called more than once per mod otherwise errors or crashes may occur.
```

--------------------------------

### Left

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/edges

Gets or sets the left edge.

```APIDOC
## Left

### Description
The left edge.

### Property
`public int Left { get; set; }`
```

--------------------------------

### BehaviorFactory()

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/behaviors/behaviorfactory

Initializes a new instance of the BehaviorFactory class.

```APIDOC
## BehaviorFactory()

### Description
Initializes a new instance of the BehaviorFactory class.

### Method
Constructor

### Signature
csharp
public BehaviorFactory();


```

--------------------------------

### Bottom

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/edges

Gets or sets the bottom edge.

```APIDOC
## Bottom

### Description
The bottom edge.

### Property
`public int Bottom { get; set; }`
```

--------------------------------

### Label widget with C# view model example

Source: https://focustense.github.io/StardewUI/library/standard-views

Displays text as a single line or paragraph. Use max-lines to limit length; font accepts small (default), dialogue, or tiny. The C# example shows creating a menu from a view asset with a view model that supplies the text.

```StarML
<label max-lines="6" text={Text} />

```

```C#
class LabelTestViewModel
{
    public string Text { get; set; }
}

void ShowLabelExample()
{
    Game1.activeClickableMenu = viewEngine.CreateMenuFromAsset(
        $"Mods/focustense.StardewUITest/Views/LabelTestView",
        new LabelTestViewModel()
        {
            Text = "Out in the kitchen. That skillet good and greasy John Henry "
                 + "has been the ruin of me, the buggies and the hacks all "
                 + "formed in line steel driving crew weevil cold blow winds "
                 + "constant sorrow, turkey in the straw, five dollars one arm "
                 + "round my whiskey keg sun would shine when I was a "
                 + "little boy aces backed with eights, wheel hoss baby on her "
                 + "knee handsome stranger Jack-a-Diamonds out in the kitchen."
        });
}

```

--------------------------------

### Type

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/grammar/token

Property that gets the token type.

```APIDOC
## Property: Type

### Description
Gets the token type.

### Signature
csharp
public StardewUI.Framework.Grammar.TokenType Type { get; }


### Property Value
TokenType

```

--------------------------------

### Name Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/descriptors/precompiledpropertydescriptor-2

Gets the name of the member.

```APIDOC
## Property: Name

### Description
Gets the member name.

### Property Value
string

### Signature
```csharp
public string Name { get; }
```

```

--------------------------------

### SliceSettings Class

Source: https://focustense.github.io/StardewUI/reference/stardewui/graphics/slicesettings

Documentation for the SliceSettings class, including its constructor, properties, and methods.

```APIDOC
## SliceSettings Constructor

### Description
Initializes a new instance of the SliceSettings class with the specified nine-slice settings.

### Constructor
`public SliceSettings(int? CenterX, SliceCenterPosition CenterXPosition, int? CenterY, SliceCenterPosition CenterYPosition, float Scale, bool EdgesOnly)`

### Parameters
- **CenterX** (Nullable<Int32>) - The X position to use for the horizontal center slices, or `null` to start where the left fixed edge ends.
- **CenterXPosition** (SliceCenterPosition) - Specifies whether the CenterX should be understood as the start position or the end position of the horizontal center slice.
- **CenterY** (Nullable<Int32>) - The Y position to use for the vertical center slices, or `null` to start where the top fixed edge ends.
- **CenterYPosition** (SliceCenterPosition) - Specifies whether the CenterY should be understood as the start position or the end position of the vertical center slice.
- **Scale** (Single) - Scale to apply to the slices themselves; for example, if a 16x16 source draws to a 64x64 target, and a scale of 2 is used, then a 2x3 border slice would draw as 16x24 (normal 8x16, multiplied by 2).
- **EdgesOnly** (Boolean) - If `true`, then only the outer 8 edge segments should be drawn, and the 9th (horizontal and vertical middle, i.e. "background") segment will be ignored.

### Returns
No return value.

## SliceSettings Properties

### CenterX

#### Description
Gets or sets the X position to use for the horizontal center slices, or `null` to start where the left fixed edge ends.

#### Property Signature
`public int? CenterX { get; set; }`

#### Property Value
Nullable<Int32>

### CenterXPosition

#### Description
Gets or sets a value specifying whether the CenterX should be understood as the start position or the end position of the horizontal center slice.

#### Property Signature
`public SliceCenterPosition CenterXPosition { get; set; }`

#### Property Value
SliceCenterPosition

### CenterY

#### Description
Gets or sets the Y position to use for the vertical center slices, or `null` to start where the top fixed edge ends.

#### Property Signature
`public int? CenterY { get; set; }`

#### Property Value
Nullable<Int32>

### CenterYPosition

#### Description
Gets or sets a value specifying whether the CenterY should be understood as the start position or the end position of the vertical center slice.

#### Property Signature
`public SliceCenterPosition CenterYPosition { get; set; }`

#### Property Value
SliceCenterPosition

### EdgesOnly

#### Description
Gets or sets a value indicating whether only the outer 8 edge segments should be drawn, and the 9th (horizontal and vertical middle, i.e. "background") segment will be ignored.

#### Property Signature
`public bool EdgesOnly { get; set; }`

#### Property Value
Boolean

### Scale

#### Description
Gets or sets the scale to apply to the slices themselves; for example, if a 16x16 source draws to a 64x64 target, and a scale of 2 is used, then a 2x3 border slice would draw as 16x24 (normal 8x16, multiplied by 2).

#### Property Signature
`public float Scale { get; set; }`

#### Property Value
Single

### EqualityContract

#### Description
Gets the equality contract type for this instance.

#### Property Signature
`protected System.Type EqualityContract { get; }`

#### Property Value
Type

## SliceSettings Methods

### WithScale(float)

#### Description
Creates a copy of this SliceSettings with a different scale.

#### Method Signature
`public SliceSettings WithScale(float newScale)`

#### Parameters
- **newScale** (Single) - The scale to use.

#### Returns
SliceSettings - A copy of this SliceSettings with its Scale set to `newScale`.
```

--------------------------------

### .csproj: Set Build Action and Copy to Output Directory for config.sml

Source: https://focustense.github.io/StardewUI/getting-started/adding-ui-assets

Add these item groups to the project file when standard IDE build settings are not used. Include the .sml file as Content and copy it to the output directory with PreserveNeweset.

```XML
<ItemGroup>
  <None Remove="assets\views\config.sml" />
</ItemGroup>

<ItemGroup>
  <Content Include="assets\views\config.sml">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </Content>
</ItemGroup>

```

--------------------------------

### IMemberDescriptor.DeclaringType

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/descriptors/imemberdescriptor

Gets the type on which the member is declared.

```APIDOC
## IMemberDescriptor.DeclaringType

### Description
Gets the type on which the member is declared.

### Property
`System.Type DeclaringType { get; }`

### Property Value
- **Type** (System.Type) - The type on which the member is declared.

```

--------------------------------

### ContextUpdatingNodeDecorator.Children Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/binding/contextupdatingnodedecorator

Gets the children of this node.

```APIDOC
## Property: Children

### Description
Gets the children of this node.

### Signature
```csharp
public System.Collections.Generic.IReadOnlyList<StardewUI.Framework.Binding.IViewNode.Child> Children { get; }
```

### Property Value
IReadOnlyList<Child>

### Remarks
Node children represent views in potentia. Every DOM node maps to (at least) one IViewNode, but views are created lazily and may not exist for nodes with conditional attributes or other rules.
```

--------------------------------

### LayoutParameters()

Source: https://focustense.github.io/StardewUI/reference/stardewui/layout/layoutparameters

Initializes a new LayoutParameters instance with default layout settings.

```APIDOC
## LayoutParameters()

### Description
Initializes a new LayoutParameters with default layout settings.

### Method
Constructor

### Signature
```csharp
public LayoutParameters();
```

```

--------------------------------

### Children Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/binding/backoffnodedecorator

Gets the children of this node.

```APIDOC
## Children Property

### Description
Gets the children of this node.

### Property Signature
`public System.Collections.Generic.IReadOnlyList<StardewUI.Framework.Binding.IViewNode.Child> Children { get; }`

### Property Value
IReadOnlyList<Child>

### Remarks
Node children represent views in potentia. Every DOM node maps to (at least) one IViewNode, but views are created lazily and may not exist for nodes with conditional attributes or other rules.

```

--------------------------------

### ViewEngine.CreateMenuControllerFromAsset(string, Object)

Source: https://focustense.github.io/StardewUI/reference/stardewui/framework/api/viewengine

Creates a menu from a StarML asset and returns a controller for customizing its behavior.

```APIDOC
## ViewEngine.CreateMenuControllerFromAsset(string, Object)

### Description
Creates a menu from the StarML stored in a game asset, as provided by a mod via SMAPI or Content Patcher, and returns a controller for customizing the menu's behavior.

### Method
CreateMenuControllerFromAsset

### Signature
`public StardewUI.Framework.IMenuController CreateMenuControllerFromAsset(string assetName, System.Object context)`

### Parameters
- **assetName** (string) - Required - The name of the StarML view asset in the content pipeline, e.g. `Mods/MyMod/Views/MyView`.
- **context** (Object) - Required - The context, or "model", for the menu's view, which holds any data-dependent values. **Note:** The type must implement INotifyPropertyChanged in order for any changes to this data to be automatically reflected in the UI.

### Returns
IMenuController - A controller object whose Menu is the created menu and whose other properties can be used to change menu-level behavior.

### Remarks
The menu that is created is the same as the result of CreateMenuFromMarkup(string, Object). The menu is not automatically shown; to show it, use activeClickableMenu or equivalent.

```

--------------------------------

### XAML vs StarML binding redirect comparison

Source: https://focustense.github.io/StardewUI/framework/starml

Compares XAML binding syntax with StarML's context redirect syntax. The XAML example shows verbose RelativeSource bindings, while the StarML example uses the ^ and ~ modifiers for the same purpose.

```xml
<Label Content="{Binding Path=DisplayName, RelativeSource={RelativeSource Mode=FindAncestor AncestorLevel=1}}"/>
<Label Content="{Binding Path=DisplayName, RelativeSource={RelativeSource Mode=FindAncestor AncestorType={x:Type Foo}}}"/>

```

```xml
<label text={^DisplayName} />
<label text={~DisplayName} />

```

--------------------------------

### Trace.Begin(Object, string)

Source: https://focustense.github.io/StardewUI/reference/stardewui/diagnostics/trace

Begins tracking a new operation (slice) using a caller object and member name. Returns a disposable that stops tracking and records duration when disposed.

```APIDOC
## Method: Begin(Object, string)

### Description
Begins tracking a new operation (slice) with a caller object and member name.

### Method Signature
```csharp
public static System.IDisposable Begin(System.Object caller, string memberName);
```

### Parameters
- **caller** (Object) - Required - Reference to the object performing the traced operation.
- **memberName** (string) - Required - Name of the member (method or property) about to begin execution.

### Returns
- **IDisposable** - A disposable instance which, when disposed, stops tracking this operation and records the duration it took, for subsequent writing to the trace file.

### Remarks
Slices must be disposed in the opposite order in which they are created, otherwise the final trace may be considered invalid.
```

--------------------------------

### Number Property

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/tinynumberlabel

Gets or sets the number to display.

```csharp
public int Number { get; set; }
```

--------------------------------

### Grid Constructor

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/grid

Initializes a new instance of the Grid class.

```APIDOC
## Grid()

### Description
Initializes a new instance of the Grid class.

### Syntax
```csharp
public Grid();
```

```

--------------------------------

### GetChildren(bool)

Source: https://focustense.github.io/StardewUI/reference/stardewui/iview

Gets the current children of this view.

```APIDOC
## GetChildren(bool)

### Description
Gets the current children of this view.

### Method
GetChildren

### Signature
`System.Collections.Generic.IEnumerable<StardewUI.ViewChild> GetChildren(bool includeFloatingElements)`

### Parameters
- **includeFloatingElements** (Boolean) - Required - Whether to include views that are not direct children, but instead members of the floating elements collection of an IFloatContainer implementation.

### Returns
IEnumerable<ViewChild>
```

--------------------------------

### Trace.Begin(string)

Source: https://focustense.github.io/StardewUI/reference/stardewui/diagnostics/trace

Begins tracking a new operation (slice) with a given name. Returns a disposable that stops tracking and records duration when disposed.

```APIDOC
## Method: Begin(string)

### Description
Begins tracking a new operation (slice) with the specified name.

### Method Signature
```csharp
public static System.IDisposable Begin(string name);
```

### Parameters
- **name** (string) - Required - The name that should appear in the trace log/visualization.

### Returns
- **IDisposable** - A disposable instance which, when disposed, stops tracking this operation and records the duration it took, for subsequent writing to the trace file.

### Remarks
Slices must be disposed in the opposite order in which they are created, otherwise the final trace may be considered invalid.
```

--------------------------------

### Title

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/scrollableframeview

Gets or sets the title displayed above the content.

```APIDOC
## Property: Title

### Description
Title to display above the Content.

### Type
string

### Access
Get/Set

### Remarks
All titles are displayed as a Banner.

### Signature
```csharp
public string Title { get; set; }
```

```

--------------------------------

### Push(IOverlay) static method

Source: https://focustense.github.io/StardewUI/reference/stardewui/overlays/overlay

Pushes an overlay to the front. If the specified overlay is already in the stack, it is moved from its previous position to the front. Applies to the ambient OverlayContext, and is ignored if no context is available.

```csharp
public static void Push(StardewUI.Overlays.IOverlay overlay);
```

--------------------------------

### Orientation property

Source: https://focustense.github.io/StardewUI/reference/stardewui/widgets/lane

Gets or sets the layout orientation.

```csharp
public StardewUI.Layout.Orientation Orientation { get; set; }
```

--------------------------------

### Trace.Begin(Func<string>, string)

Source: https://focustense.github.io/StardewUI/reference/stardewui/diagnostics/trace

Begins tracking a new operation (slice) using a caller name function and member name. Returns a disposable that stops tracking and records duration when disposed.

```APIDOC
## Method: Begin(Func<string>, string)

### Description
Begins tracking a new operation (slice) with a caller name function and member name.

### Method Signature
```csharp
public static System.IDisposable Begin(Func<string> callerName, string memberName);
```

### Parameters
- **callerName** (Func<string>) - Required - Reference to the name (e.g. type name) of the object performing the traced operation.
- **memberName** (string) - Required - Name of the member (method or property) about to begin execution.

### Returns
- **IDisposable** - A disposable instance which, when disposed, stops tracking this operation and records the duration it took, for subsequent writing to the trace file.

### Remarks
Slices must be disposed in the opposite order in which they are created, otherwise the final trace may be considered invalid.
```

--------------------------------

### GetCloseBehavior()

Source: https://focustense.github.io/StardewUI/reference/stardewui/viewmenu

Gets the current close behavior for the menu.

```APIDOC
## GetCloseBehavior()

### Description
Gets the current close behavior for the menu.

### Syntax
```csharp
protected virtual StardewUI.MenuCloseBehavior GetCloseBehavior();
```

### Returns
MenuCloseBehavior

### Remarks
The default implementation always returns Default. Subclasses may override this in order to use CustomClose(), or disable closure entirely.
```

--------------------------------

### TooltipData Constructor

Source: https://focustense.github.io/StardewUI/reference/stardewui/data/tooltipdata

Initializes a new instance of the TooltipData record with all tooltip data fields.

```APIDOC
## Constructor

### Description
Initializes a new instance of the TooltipData record with the specified parameters.

### Signature
```csharp
public TooltipData(string Title, string Text, Item Item, int? RequiredItemId, int RequiredItemAmount, string CurrencySymbol, int CurrencyAmount, CraftingRecipe CraftingRecipe, IList<Item> AdditionalCraftingMaterials)
```

### Parameters
- **Title** (string) - The bolded title to display above the text.
- **Text** (string) - The primary description text to display.
- **Item** (Item) - The specific game item that is the topic of the tooltip, if any.
- **RequiredItemId** (int?) - Item ID to show as a required item, usually used for non-currency trades.
- **RequiredItemAmount** (int) - The number of items required when RequiredItemId is specified.
- **CurrencySymbol** (string) - The currency associated with any CurrencyAmount.
- **CurrencyAmount** (int) - Amount of money associated with the tooltip action.
- **CraftingRecipe** (CraftingRecipe) - Crafting recipe to show if the tooltip is for a craftable item.
- **AdditionalCraftingMaterials** (IList<Item>) - List of additional items required for crafting not included in the recipe.

### Remarks
All parameters are required for the constructor call.
```
Tokens:
Raw