Component:BreadcrumbInterface

From Resonite Wiki
Revision as of 20:47, 3 February 2025 by 989onan (talk | contribs) (add info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Breadcrumb Interface component as seen in the Scene Inspector

The BreadcrumbInterface component is used by data feeds to get the translated name of one directory in a list of directories that makes a path. This is most commonly used in the Settings at the top to show a user where in the settings they are.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
NameConverter delegate of identity PathSegmentConverter The path segment converter Sync delegate (Takes a path name and its depth) and returns a localized string.
ItemName IField`1<String> The field to drive with the localized string of the path segment (on an OS, this would be like the programmer name of a folder translated to your language)
PathSegment String The path segment programmer name to convert to your language.
ItemDepth Int How many levels down in the path this string element would be.

Usage

Used with a BreadcrumbManager to generate a list of path elements to show to the user in their language.

Examples

Used in the settings header to show a user what setting they are currently viewing.

See Also