Component:SettingsDataFeed: Difference between revisions

Latest revision as of 15:19, 14 April 2025

Component image

The SettingsDataFeed component is a data feed that generates a list of settings and their categories.

Using this outside of userspace and interacting with it can crash the session!

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.

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`PathSegmentName:PathSegmentConverter`	PathSegmentConverter	X	Gets the locale string of a path using a depth and a name.

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Used for the settings facet used in the settings tab of the dash menu.

@@ Line 3: / Line 3: @@
 |Name=Settings Data Feed
 }}
-{{stub}}
+The '''SettingsDataFeed''' component is a [[Data Feed|data feed]] that generates a list of [[settings]] and their categories.
+{{Note|Using this outside of [[userspace]] and interacting with it can crash the session!|warning}}
 == Usage ==
-{{Table ComponentFields
-}}
+{{Table ComponentFields}}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|PathSegmentName()|[[Type:PathSegmentConverter|PathSegmentConverter]]&lt;[[Type:String|String]]: pathSegment, [[Type:Int|Int]]: depth&gt;|
+|PathSegmentName:[[Type:PathSegmentConverter|PathSegmentConverter]]|[[Type:PathSegmentConverter|PathSegmentConverter]]|false| Gets the locale string of a path using a depth and a name.
 }}
-== Behavior ==
+== Usage ==
+{{stub}}
 == Examples ==
+Used for the settings facet used in the settings tab of the [[Dash Menu|dash menu]].
 == See Also ==
+* [[Settings]]
 [[Category:Components:Utility{{#translation:}}|Settings Data Feed]]
 [[Category:Components{{#translation:}}|Settings Data Feed]]
-[[Category:ComponentStubs]]
-[[Category:ComponentStubs]]