Component:RadiantSearchBar: Difference between revisions

From Resonite Wiki
add info
Automated: update Fields, SyncDelegates
Line 10: Line 10:
|IsSearching|Bool| Whether this component is currently searching.
|IsSearching|Bool| Whether this component is currently searching.
|SearchAnimTileSpeed|Float| How fast the search animation scrolling speed should be.
|SearchAnimTileSpeed|Float| How fast the search animation scrolling speed should be.
|SearchAnimColor|ColorX| What the color of the search bar should be while searching.  
|SearchAnimColor|ColorX| What the color of the search bar should be while searching.
|_textField|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| The text field for entering a search.
|_textField|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| The text field for entering a search.
|_searchText|{{RootFieldType|RelayRef`1|[[Component:Text|Text]]}}|TypeAdv5=true| The text UIX Component for searching
|_searchText|{{RootFieldType|RelayRef`1|[[Component:Text|Text]]}}|TypeAdv5=true| The text UIX Component for searching
Line 22: Line 22:


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers  
{{Table ComponentTriggers
|OnCancel()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]] button, [[Type:ButtonEventData|ButtonEventData]] eventData>| Cancels the current search.
|OnCancel[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
}}
}}



Revision as of 06:04, 17 March 2025

Component image 
Radiant Search Bar component as seen in the Scene Inspector

The RadiantSearchBar component is most commonly used and found in the World Browser.

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.
SearchTerm String The term this is searching for.
IsSearching Bool Whether this component is currently searching.
SearchAnimTileSpeed Float How fast the search animation scrolling speed should be.
SearchAnimColor ColorX What the color of the search bar should be while searching.
_textField TextField The text field for entering a search.
_searchText direct RelayRef`1<Text> The text UIX Component for searching
_defaultText Text The text UIX Component that should be visible if a search term has not yet been entered.
_searchingVisual TiledRawImage The visual to show while searching
_cancelButton Button The button that can be used to cancel a currently running search.
_defaultVisible field drive of Bool The field to drive with what should be visible by default.
_searchingAnimationColor field drive of ColorX The field to drive for the color of the searching animation visual.
_searchingTextureOffset field drive of Float2 The offset field to drive to create the searching animation scrolling visual.

Sync Delegates

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

Usage

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

Examples

Used in the RedX UI.

See Also