Component:RootCategoryView: Difference between revisions

Revision as of 19:33, 1 February 2025

Component image

**Root Category View** component as seen in the Scene Inspector

The RootCategoryView component is commonly used in Settings, and Worlds Menu view to show the list of root view categories while still showing the current Path like audio device lists, trackers, worlds, or anything else feeds might have.

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.
`Feed`	IDataFeedComponent	The feed to get data from.
`Path`	direct SyncFieldList`1<String>	The path within the feed to send to `ItemsManager`.
`GroupingKeys`	direct SyncFieldList`1<String>
`SearchPhrase`	String	The phrase to search for within the current `Path`
`UpdatingUser`	direct UserRef	The user handling the logic for this component.
`ResetViewOnSave`	Bool	Whether to clear the view upon saving this component.
`CategoryManager`	direct DataFeedItemMappingManager	The Mapper to handle showing categories in the root regardless of what `Path` is.
`ItemsManager`	direct DataFeedItemMappingManager	The Mapper to handle showing items within a selected category, no matter how deep of a `Path` this is viewing.

Sync Delegates

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description

Usage

Attach to a slot and provide a Feed, a Item Mapper, and Slots to place items in order for it to work.

Examples

Used in the settings and world views.

@@ Line 3: / Line 3: @@
 |Name=Root Category View
 }}
-{{stub}}
+The '''RootCategoryView''' component is commonly used in [[Settings]], and [[Worlds Menu]] view to show the list of root view categories while still showing the current <code>Path</code> like audio device lists, trackers, worlds, or anything else feeds might have.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Feed|IDataFeedComponent|
+|Feed|IDataFeedComponent| The feed to get data from.
-|Path|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true|
+|Path|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true| The path within the feed to send to <code>ItemsManager</code>.
 |GroupingKeys|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv2=true|
-|SearchPhrase|String|
+|SearchPhrase|String| The phrase to search for within the current <code>Path</code>
-|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true|
+|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true| The user handling the logic for this component.
-|ResetViewOnSave|Bool|
+|ResetViewOnSave|Bool| Whether to clear the view upon saving this component.
-|CategoryManager|{{RootFieldType|DataFeedItemMappingManager}}|TypeAdv6=true|
+|CategoryManager|{{RootFieldType|DataFeedItemMappingManager}}|TypeAdv6=true| The Mapper to handle showing categories in the root regardless of what <code>Path</code> is.
-|ItemsManager|{{RootFieldType|DataFeedItemMappingManager}}|TypeAdv7=true|
+|ItemsManager|{{RootFieldType|DataFeedItemMappingManager}}|TypeAdv7=true| The Mapper to handle showing items within a selected category, no matter how deep of a <code>Path</code> this is viewing.
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|PathSegmentName()|[[Type:PathSegmentConverter|PathSegmentConverter]]&lt;[[Type:String|String]]: pathSegment, [[Type:Int|Int]]: depth&gt;|
+|PathSegmentName()|[[Type:PathSegmentConverter|PathSegmentConverter]]&lt;[[Type:String|String]]: pathSegment, [[Type:Int|Int]]: depth&gt;| Turns a string representing a Path location into a number representing how far down it is in the feed.
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot and provide a [[Type:IDataFeedView|Feed]], a [[Component:DataFeedItemMapper|Item Mapper]], and Slots to place items in order for it to work.
 == Examples ==
+Used in the settings and world views.
 == See Also ==
+* [[Type:IDataFeedView|Other Data Feed Views]]
 [[Category:Components:Radiant UI:Data Feeds:Views{{#translation:}}|Root Category View]]
 [[Category:Components{{#translation:}}|Root Category View]]
-[[Category:ComponentStubs]]