Component:RootCategoryView: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
update
 
(9 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Root Category View
|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
{{Table ComponentFields
|Feed|IDataFeedComponent|
|Feed|IDataFeedComponent| {{Template:IDataFeedView_Feed}}
|Path|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true|
|Path|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true| {{Template:IDataFeedView_Path}}
|GroupingKeys|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv2=true|
|GroupingKeys|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv2=true| {{Template:IDataFeedView_GroupingKeys}}
|SearchPhrase|String|
|SearchPhrase|String| {{Template:IDataFeedView_SearchPhrase}}
|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true|
|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true|{{Template:IDataFeedView_UpdatingUser}}
|ResetViewOnSave|Bool|
|ResetViewOnSave|Bool|{{Template:IDataFeedView_ResetViewOnSave}}
|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 <code>Path</code>, no matter how deep of a <code>Path</code> this is viewing.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|OnSetupTemplate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the setup template button is touched.
|PathSegmentName:[[Type:PathSegmentConverter|PathSegmentConverter]]|[[Type:PathSegmentConverter|PathSegmentConverter]]|false| Converts a path name element and a depth into a corresponding locale string for translation.
}}
}}


== 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 ==
== Examples ==
Used in the settings and world views.


== See Also ==
== See Also ==
* [[Type:IDataFeedView|Other Data Feed Views]]
* [[Data Feeds]]


[[Category:Components:Radiant UI:Data Feeds:Views{{#translation:}}|Root Category View]]
[[Category:Components:Radiant UI:Data Feeds:Views{{#translation:}}|Root Category View]]
[[Category:Components{{#translation:}}|Root Category View]]
[[Category:Components{{#translation:}}|Root Category View]]
[[Category:ComponentStubs]]

Latest revision as of 01:55, 9 April 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 view items for in this data feed view.
Path direct SyncFieldList`1<String> The path within the feed to view.
GroupingKeys direct SyncFieldList`1<String> A list of grouping keys to group alike data feed items together from the incoming data.
SearchPhrase String The phrase to search for within the current list of feed items under Path.
UpdatingUser direct UserRef The user handling the logic for this data feed view.
ResetViewOnSave Bool Whether to clear the view upon saving this data feed view.
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 Path, no matter how deep of a Path this is viewing.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnSetupTemplate:ButtonEventHandler ButtonEventHandler Called when the setup template button is touched.
PathSegmentName:PathSegmentConverter PathSegmentConverter X Converts a path name element and a depth into a corresponding locale string for translation.

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.

See Also