UniWebViewEmbeddedToolbarConfig

Summary

Represents the configuration for the embedded toolbar.

A config object describes the full toolbar layout: which items appear (back, forward, done, reload, title, or custom buttons), how they are arranged (left, center, right sections), their colors, and title interaction behaviors.

Use UniWebViewEmbeddedToolbarConfig.Default for the standard layout (back + forward on the left, title in the center, done on the right), or construct your own config. Apply the config by calling UniWebViewEmbeddedToolbar.ApplyConfig.

Properties Summary

int CurrentVersion { get; }	The current config version.
string BuiltInIdentifierPrefix { get; }	The prefix used for all built-in item identifiers (`"uwv.
string BuiltInIdentifier.Back { get; }	Identifier for the back navigation button (`"uwv.
string BuiltInIdentifier.Forward { get; }	Identifier for the forward navigation button (`"uwv.
string BuiltInIdentifier.Done { get; }	Identifier for the done (close) button (`"uwv.
string BuiltInIdentifier.Reload { get; }	Identifier for the reload button (`"uwv.
string BuiltInIdentifier.Title { get; }	Identifier for the title item (`"uwv.
UniWebViewEmbeddedToolbarConfig.ItemType ItemType.BuiltIn { get; }	A built-in item with predefined behavior (back, forward, done, reload, title).
UniWebViewEmbeddedToolbarConfig.ItemType ItemType.Custom { get; }	A custom button defined by the user.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Back { get; }	Back navigation button.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Forward { get; }	Forward navigation button.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Done { get; }	Done (close) button.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Reload { get; }	Reload button.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Title { get; }	Title label displayed in the center section.
UniWebViewEmbeddedToolbarConfig Default { get; }	Gets the default toolbar config.
string DefaultJson { get; }	Gets the JSON string representation of the default config.
int Version { get; set; }	The config version.
bool Visible { get; set; }	Whether the toolbar is visible.
UniWebViewToolbarPosition Position { get; set; }	The position of the toolbar.
float? MaxHeight { get; set; }	The maximum height of the toolbar in points.
UniWebViewEmbeddedToolbarConfig.ColorValue BackgroundColor { get; set; }	The background color of the toolbar.
UniWebViewEmbeddedToolbarConfig.ColorValue ButtonTextColor { get; set; }	The default text color for toolbar buttons (back, forward, done, reload, custom).
UniWebViewEmbeddedToolbarConfig.ColorValue TitleTextColor { get; set; }	The text color for the title item.
List<UniWebViewEmbeddedToolbarConfig.Item> Left { get; set; }	The list of items to display on the left section of the toolbar.
List<UniWebViewEmbeddedToolbarConfig.Item> Center { get; set; }	The list of items to display in the center section of the toolbar.
List<UniWebViewEmbeddedToolbarConfig.Item> Right { get; set; }	The list of items to display on the right section of the toolbar.
float ColorValue.r { get; set; }	Red component, in the range [0, 1].
float ColorValue.g { get; set; }	Green component, in the range [0, 1].
float ColorValue.b { get; set; }	Blue component, in the range [0, 1].
float ColorValue.a { get; set; }	Alpha component, in the range [0, 1].
UniWebViewEmbeddedToolbarConfig.ColorValue ItemStyle.TextColor { get; set; }	The text color of this item.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.TapAction.None { get; }	No action on tap.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.TapAction.ScrollToTop { get; }	Scroll the web view content to the top of the page.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.LongPressAction.None { get; }	No action on long press.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.LongPressAction.CopyUrl { get; }	Copy the current page URL to the system clipboard and show a toast.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.OnTap { get; set; }	The action to perform when the title is tapped.
UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.OnLongPress { get; set; }	The action to perform when the title is long-pressed.
string TitleInteraction.CopyToastText { get; set; }	The toast message text shown after copying the URL.
UniWebViewEmbeddedToolbarConfig.ItemType Item.Type { get; set; }	The type of this item (built-in or custom).
string Item.Identifier { get; set; }	A unique identifier for this item.
UniWebViewEmbeddedToolbarConfig.ItemStyle Item.Style { get; set; }	Optional per-item visual style.
UniWebViewEmbeddedToolbarConfig.BuiltInItemKind? Item.Kind { get; set; }	The kind of built-in item.
string Item.Title { get; set; }	The display text for this item.
bool? Item.Visible { get; set; }	Whether this item is visible.
UniWebViewEmbeddedToolbarConfig.TitleInteraction Item.TitleInteraction { get; set; }	Interaction config for the built-in Title item.

Methods Summary

UniWebViewEmbeddedToolbarConfig UniWebViewEmbeddedToolbarConfig.FromJson(string json)	Creates a config from a JSON string.
string ToJson()	Serializes the config to a JSON string.
Dictionary<string, object> ToDictionary()	Converts the config to a dictionary representation that can be serialized to JSON.
IEnumerable<UniWebViewEmbeddedToolbarConfig.Item> EnumerateItems()	Enumerates all items across all sections (left, center, right) in order.
UniWebViewEmbeddedToolbarConfig.Item FindFirstBuiltInItem(UniWebViewEmbeddedToolbarConfig.BuiltInItemKind kind)	Finds the first built-in item matching the given kind across all sections (left, center, right).
UniWebViewEmbeddedToolbarConfig.ColorValue UniWebViewEmbeddedToolbarConfig.ColorValue.FromColor(Color color)	Creates a ColorValue from a Unity Color.
Color ColorValue.ToColor()	Converts this ColorValue to a Unity Color.
UniWebViewEmbeddedToolbarConfig.Item UniWebViewEmbeddedToolbarConfig.Item.BuiltIn(BuiltInItemKind kind, string title = null, bool? visible = null, ItemStyle style = null, TitleInteraction titleInteraction = null, string identifier = null)	Creates a built-in toolbar item.
UniWebViewEmbeddedToolbarConfig.Item UniWebViewEmbeddedToolbarConfig.Item.Custom(string identifier, string title, ItemStyle style = null)	Creates a custom toolbar button.
bool Item.IsVisible()	Returns whether this item is visible.

Properties

int CurrentVersion { get; }

const

The current config version. Currently 1.

string BuiltInIdentifierPrefix { get; }

const

The prefix used for all built-in item identifiers ("uwv.toolbar.").

string BuiltInIdentifier.Back { get; }

const

Identifier for the back navigation button ("uwv.toolbar.back").

string BuiltInIdentifier.Forward { get; }

const

Identifier for the forward navigation button ("uwv.toolbar.forward").

string BuiltInIdentifier.Done { get; }

const

Identifier for the done (close) button ("uwv.toolbar.done").

string BuiltInIdentifier.Reload { get; }

const

Identifier for the reload button ("uwv.toolbar.reload").

string BuiltInIdentifier.Title { get; }

const

Identifier for the title item ("uwv.toolbar.title").

UniWebViewEmbeddedToolbarConfig.ItemType ItemType.BuiltIn { get; }

A built-in item with predefined behavior (back, forward, done, reload, title).

UniWebViewEmbeddedToolbarConfig.ItemType ItemType.Custom { get; }

A custom button defined by the user.

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Back { get; }

Back navigation button. Default text: "❮".

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Forward { get; }

Forward navigation button. Default text: "❯".

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Done { get; }

Done (close) button. Default text: "Done".

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Reload { get; }

Reload button. Default text: "↻".

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind BuiltInItemKind.Title { get; }

Title label displayed in the center section.

UniWebViewEmbeddedToolbarConfig Default { get; }

static

Gets the default toolbar config.

The default config contains: back and forward buttons on the left, a title item in the center, and a done button on the right. Position is Top, visibility is true, and colors use platform defaults.

string DefaultJson { get; }

static

Gets the JSON string representation of the default config.

int Version { get; set; }

The config version. Currently always 1.

bool Visible { get; set; }

Whether the toolbar is visible. Default is true.

UniWebViewToolbarPosition Position { get; set; }

The position of the toolbar. Either Top or Bottom. Default is Top.

This property only takes effect on iOS and Android. On macOS Unity Editor, the toolbar is always in the window's title bar.

float? MaxHeight { get; set; }

The maximum height of the toolbar in points. If set to a value smaller than the standard height, the toolbar will shrink to that height.

This property only takes effect on iOS and Android.

UniWebViewEmbeddedToolbarConfig.ColorValue BackgroundColor { get; set; }

The background color of the toolbar. When null, the platform default is used.

UniWebViewEmbeddedToolbarConfig.ColorValue ButtonTextColor { get; set; }

The default text color for toolbar buttons (back, forward, done, reload, custom). When null, the platform default is used. Individual items can override this via Item.Style.TextColor.

UniWebViewEmbeddedToolbarConfig.ColorValue TitleTextColor { get; set; }

The text color for the title item. When null, the platform default is used. The title item can override this via its own Item.Style.TextColor.

List<UniWebViewEmbeddedToolbarConfig.Item> Left { get; set; }

The list of items to display on the left section of the toolbar.

In the default config, this contains the back and forward built-in items.

List<UniWebViewEmbeddedToolbarConfig.Item> Center { get; set; }

The list of items to display in the center section of the toolbar.

In the default config, this contains the title built-in item. You can also add other built-in or custom buttons to the center section alongside the title.

List<UniWebViewEmbeddedToolbarConfig.Item> Right { get; set; }

The list of items to display on the right section of the toolbar.

In the default config, this contains the done built-in item.

float ColorValue.r { get; set; }

Red component, in the range [0, 1].

float ColorValue.g { get; set; }

Green component, in the range [0, 1].

float ColorValue.b { get; set; }

Blue component, in the range [0, 1].

float ColorValue.a { get; set; }

Alpha component, in the range [0, 1].

UniWebViewEmbeddedToolbarConfig.ColorValue ItemStyle.TextColor { get; set; }

The text color of this item. When set, overrides the global ButtonTextColor or TitleTextColor.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.TapAction.None { get; }

No action on tap.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.TapAction.ScrollToTop { get; }

Scroll the web view content to the top of the page.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.LongPressAction.None { get; }

No action on long press.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.LongPressAction.CopyUrl { get; }

Copy the current page URL to the system clipboard and show a toast.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction TitleInteraction.OnTap { get; set; }

The action to perform when the title is tapped. Default is None.

UniWebViewEmbeddedToolbarConfig.TitleInteraction.LongPressAction TitleInteraction.OnLongPress { get; set; }

The action to perform when the title is long-pressed. Default is None.

string TitleInteraction.CopyToastText { get; set; }

The toast message text shown after copying the URL. If not set, "URL copied" is used. Only applicable when OnLongPress is CopyUrl.

UniWebViewEmbeddedToolbarConfig.ItemType Item.Type { get; set; }

The type of this item (built-in or custom).

string Item.Identifier { get; set; }

A unique identifier for this item. Built-in items use uwv.toolbar.* identifiers by default. Custom items must provide their own identifier.

UniWebViewEmbeddedToolbarConfig.ItemStyle Item.Style { get; set; }

Optional per-item visual style. When set, overrides global color settings.

UniWebViewEmbeddedToolbarConfig.BuiltInItemKind? Item.Kind { get; set; }

The kind of built-in item. Only applicable when Type is BuiltIn.

string Item.Title { get; set; }

The display text for this item. For built-in items, if not set, a platform default is used. For custom items, this is the button label.

bool? Item.Visible { get; set; }

Whether this item is visible. If null or true, the item is shown. Set to false to hide it.

UniWebViewEmbeddedToolbarConfig.TitleInteraction Item.TitleInteraction { get; set; }

Interaction config for the built-in Title item. Only applicable when Kind is Title.

Methods

UniWebViewEmbeddedToolbarConfig UniWebViewEmbeddedToolbarConfig.FromJson(string json)

static

Creates a config from a JSON string. Returns null if the JSON is invalid or empty.

Parameters

• string json

  A JSON string representing the toolbar config.

string ToJson()

Serializes the config to a JSON string.

Dictionary<string, object> ToDictionary()

Converts the config to a dictionary representation that can be serialized to JSON.

IEnumerable<UniWebViewEmbeddedToolbarConfig.Item> EnumerateItems()

Enumerates all items across all sections (left, center, right) in order.

UniWebViewEmbeddedToolbarConfig.Item FindFirstBuiltInItem(UniWebViewEmbeddedToolbarConfig.BuiltInItemKind kind)

Finds the first built-in item matching the given kind across all sections (left, center, right).

Returns null if no matching item is found.

Parameters

• UniWebViewEmbeddedToolbarConfig.BuiltInItemKind kind

  The built-in item kind to search for.

Example

var config = UniWebViewEmbeddedToolbarConfig.Default;
var titleItem = config.FindFirstBuiltInItem(
    UniWebViewEmbeddedToolbarConfig.BuiltInItemKind.Title
);
titleItem.Title = "My App";

UniWebViewEmbeddedToolbarConfig.ColorValue UniWebViewEmbeddedToolbarConfig.ColorValue.FromColor(Color color)

static

Creates a ColorValue from a Unity Color.

Parameters

• Color color

  The Unity color to convert.

Example

var color = UniWebViewEmbeddedToolbarConfig.ColorValue.FromColor(Color.red);

Color ColorValue.ToColor()

Converts this ColorValue to a Unity Color.

UniWebViewEmbeddedToolbarConfig.Item UniWebViewEmbeddedToolbarConfig.Item.BuiltIn(BuiltInItemKind kind, string title = null, bool? visible = null, ItemStyle style = null, TitleInteraction titleInteraction = null, string identifier = null)

static

Creates a built-in toolbar item.

Built-in items are: Back, Forward, Done, Reload, and Title. Each has a default text and identifier. You can override the title, visibility, style, and (for the Title item) title interaction.

Parameters

• UniWebViewEmbeddedToolbarConfig.BuiltInItemKind kind

  The kind of built-in item to create.

• string title

  Optional title text override. If null, the platform default text is used.

• bool? visible

  Optional visibility override. If null, the item is visible by default.

• UniWebViewEmbeddedToolbarConfig.ItemStyle style

  Optional style override for this item.

• UniWebViewEmbeddedToolbarConfig.TitleInteraction titleInteraction

  Optional title interaction config. Only applicable to the Title built-in item.

• string identifier

  Optional identifier override. By default, built-in items use uwv.toolbar.* identifiers.

Example

// Create a reload button.
var reload = UniWebViewEmbeddedToolbarConfig.Item.BuiltIn(
    UniWebViewEmbeddedToolbarConfig.BuiltInItemKind.Reload
);

// Create a title with scroll-to-top interaction.
var title = UniWebViewEmbeddedToolbarConfig.Item.BuiltIn(
    UniWebViewEmbeddedToolbarConfig.BuiltInItemKind.Title,
    title: "My App",
    titleInteraction: new UniWebViewEmbeddedToolbarConfig.TitleInteraction {
        OnTap = UniWebViewEmbeddedToolbarConfig.TitleInteraction.TapAction.ScrollToTop
    }
);

UniWebViewEmbeddedToolbarConfig.Item UniWebViewEmbeddedToolbarConfig.Item.Custom(string identifier, string title, ItemStyle style = null)

static

Creates a custom toolbar button.

Custom items require an identifier and a title. When tapped, the item's action is delivered through RegisterOnEmbeddedToolbarItemAction on the UniWebView instance. Custom items have no native default action.

Parameters

• string identifier

  A unique identifier for the custom item. Used to identify the item in action callbacks.

• string title

  The button title text.

• UniWebViewEmbeddedToolbarConfig.ItemStyle style

  Optional style for this item.

Example

var shareButton = UniWebViewEmbeddedToolbarConfig.Item.Custom(
    "my.share",
    "Share"
);

bool Item.IsVisible()

Returns whether this item is visible. An item is visible when Visible is null or true.