Component:BreadcrumbManager: Difference between revisions

Latest revision as of 06:30, 17 March 2025

Component image

**Breadcrumb Manager** component as seen in the Scene Inspector

The BreadcrumbManager component is used to instantiate BreadcrumbInterfaces and remove them based on the list of path elements on a Data Feed View Type.

Usage

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.
`Path`	direct RelayRef`1<SyncFieldList`1<String>>	The path field in a Data Feed View Type component to show in the form of templates.
`UI_Root`	Slot	The place to put Breadcrumb path items in.
`BreadcrumbTemplate`	BreadcrumbInterface	The template to duplicate in order to create UI.
`SeparatorTemplate`	Slot	The slot to duplicate and place between elements to make them have slashes or commas between them.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
SetDepth:ButtonEventHandler`1<Int>	ButtonEventHandler`1<Int>	X	Takes a number beside a button that when pressed will set the depth of the path.
SetDepth:Action`1<Int>	Action`1<Int>	X	Takes a number beside a button that when pressed will set the depth of the path.
`SetupTemplate:ButtonEventHandler`	ButtonEventHandler	✓

Usage

Attach to a slot and provide all fields with valid values. The manager will then allow for creating path elements automatically when navigating a data feed.

Examples

Used heavily in the Settings menu to show the current path at the top.

@@ Line 3: / Line 3: @@
 |Name=Breadcrumb Manager
 }}
-{{stub}}
+The '''BreadcrumbManager''' component is used to instantiate [[Component:BreadcrumbInterface|BreadcrumbInterface]]s and remove them based on the list of path elements on a [[Type:IDataFeedView|Data Feed View Type]].
 == Usage ==
 {{Table ComponentFields
-|Path|{{RootFieldType|RelayRef`1|[[Type:SyncFieldList`1|SyncFieldList`1]]&lt;[[Type:String|String]]&gt;}}|TypeAdv0=true|
+|Path|{{RootFieldType|RelayRef`1|[[Type:SyncFieldList`1|SyncFieldList`1]]&lt;[[Type:String|String]]&gt;}}|TypeAdv0=true| The path field in a [[Type:IDataFeedView|Data Feed View Type component]] to show in the form of templates.
-|UI_Root|Slot|
+|UI_Root|Slot| The place to put Breadcrumb path items in.
-|BreadcrumbTemplate|'''[[Component:BreadcrumbInterface|BreadcrumbInterface]]'''|TypeAdv2=true|
+|BreadcrumbTemplate|'''[[Component:BreadcrumbInterface|BreadcrumbInterface]]'''|TypeAdv2=true| The template to duplicate in order to create UI.
-|SeparatorTemplate|Slot|
+|SeparatorTemplate|Slot| The slot to duplicate and place between elements to make them have slashes or commas between them.
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|SetDepth()|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:Int|Int]]: depth&gt;|
+|SetDepth:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:Int|Int]]&gt;|false| Takes a number beside a button that when pressed will set the depth of the path.
-|SetDepth()|[[Type:Action`1|Action`1]]&lt;[[Type:Int|Int]]: depth&gt;|
+|SetDepth:[[Type:Action`1|Action`1]]&lt;[[Type:Int|Int]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Type:Int|Int]]&gt;|false| Takes a number beside a button that when pressed will set the depth of the path.
+|SetupTemplate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot and provide all fields with valid values. The manager will then allow for creating path elements automatically when navigating a data feed.
 == Examples ==
+Used heavily in the [[Settings]] menu to show the current path at the top.
 == See Also ==
+* [[Data Feeds]]
+* [[Component:BreadcrumbInterface]]
 [[Category:Components:Radiant UI:Navigation{{#translation:}}|Breadcrumb Manager]]
 [[Category:Components{{#translation:}}|Breadcrumb Manager]]
-[[Category:ComponentStubs]]