Component:RootCategoryView: Difference between revisions

From Resonite Wiki
add info
add info
Line 7: Line 7:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Feed|IDataFeedComponent| The feed to get data from.
|Feed|IDataFeedComponent| {{Template:IDataFeedView_Feed}}
|Path|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true| The path within the feed to send to <code>ItemsManager</code>.
|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| The phrase to search for within the current <code>Path</code>
|SearchPhrase|String| {{Template:IDataFeedView_SearchPhrase}}
|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true| The user handling the logic for this component.
|UpdatingUser|{{RootFieldType|UserRef}}|TypeAdv4=true|{{Template:IDataFeedView_UpdatingUser}}
|ResetViewOnSave|Bool| Whether to clear the view upon saving this component.
|ResetViewOnSave|Bool|{{Template:IDataFeedView_ResetViewOnSave}}
|CategoryManager|{{RootFieldType|DataFeedItemMappingManager}}|TypeAdv6=true| The Mapper to handle showing categories in the root regardless of what <code>Path</code> is.
|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| The Mapper to handle showing items within a selected category, no matter how deep of a <code>Path</code> this is viewing.
|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.
}}
}}


Line 30: Line 30:
== See Also ==
== See Also ==
* [[Type:IDataFeedView|Other Data Feed Views]]
* [[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]]

Revision as of 20:20, 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 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

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.

See Also