tencent cloud

Chat

News and Announcements
Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Scenarios
Features
Account System
User Profile and Relationship Chain
Message Management
Group Related
Official Account
Audio/Video Call
Use Limits
Purchase Guide
Billing Overview
Pricing
Purchase Instructions
Renewal Guide
Service Suspension Explanation
Refund Policy
Development Guidelines
Demo Zone
Activate Service
Free Demos
Quick Run
Download
SDK and Demo Source Code
Update Log
Chat Interaction (UI Included)
TUIKit Introduction
Getting Started
Full-feature Integration
Single-function Integration
Build with AI
Build Basic Interfaces
More Features
Customizing Appearance
Internationalization
Push Service
Overview
Noun explanation
Activate the Service
Quick Start
Manufacturer Channel
Statistics
Troubleshooting Tool
Client APIs
REST API
Push Callback
Advanced Features
Release Notes
Error Codes
FAQS
Desk
Overview
Quick Start
Integration Guide
Admin Operation Manual
Agent Manual
More Practices
Live Streaming Setup Guide
AI Chatbot
Super Large Entertainment and Collaboration Community
Discord Implementation Guide
How to Integrate Chat into Games
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
No UI Integration
Quick Start
SDK Integration
Initialization
Login and Logout
Message
Conversation
Group
Community Topic
User Profile and Relationship Chain
Offline Push
Cloud Search
Local Search
Official Channel Management
Client APIs
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Server APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
Console Guide
New Console Introduction
Creating and Upgrading an Application
Basic Configuration
Feature Configuration
Account Management
Group Management
Official Channel Management
Webhook Configuration
Usage
Viewing Guide for Resource Packages
Real-Time Monitor
Auxiliary Development Tools
Access Management
Advanced Features
FAQs
uni-app FAQs
Purchase
SDK
Account Authentication
User Profile and Relationship Chain
Message
Group
Audio-Video Group
Nickname and Profile Photo
Security Compliance Certification
Service Level Agreement
Security Compliance Certification
Chat Policies
Privacy Policy
Data Privacy and Security Agreement
Migration
Migration Solutions
Migration Solutions Lite
Error Codes
Contact Us
DocumentationChatChat Interaction (UI Included)Single-function IntegrationSearchReactSearch State

Search State

PDF
Focus Mode
Font Size
Last updated: 2025-07-22 17:28:42
SearchState is a search state management hook based on Zustand, providing complete status management capacity for the Search component. It supports various search modes (standard mode, embedded mode) and manages search keywords, search results, loading status, error handling, and other features. If the customize component power cannot support your business, you can use SearchState to implement your needs.

Data

Attribute Name
Type
Description
keyword
string
current search keyword
results
Map<SearchType, SearchResult<SearchType>>
search result set
isLoading
boolean
whether searching
error
Error | null
error information
searchAdvancedParams
Map<ISearchType, SearchParamsMap[SearchType]>
Advanced search parameters
selectedSearchType
SearchType | 'all'
Current search type

Operation Method

Method Name
Type
Description
setKeyword
(k: string) => void
Set search keyword
loadMore
(type?: SearchType) => Promise<void>
Load more search results
setSelectedType
(type: SearchType | 'all') => void
Set search type
setSearchMessageAdvancedParams
(params: SearchCloudMessagesParams) => void
Set advanced message search parameters
setSearchUserAdvancedParams
(params: SearchCloudUsersParams) => void
Set advanced user search parameters
setSearchGroupAdvancedParams
(params: SearchCloudGroupsParams) => void
Set advanced group search parameters

Usage Examples

import { useSearchState, VariantType } from '@tencentcloud/chat-uikit-react';
const {
    keyword,
    results,
    isLoading,
    error,
    setKeyword,
    setSelectedType,
    loadMore
  } = useSearchState(VariantType.STANDARD);



Previous Topic: SearchNext Topic: Overview

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback