משתמשים בסרגל חיפוש כדי להטמיע פונקציונליות של חיפוש. סרגל חיפוש הוא שדה חיפוש קבוע שמאפשר למשתמשים להזין מילת מפתח או ביטוי כדי להציג תוצאות רלוונטיות באפליקציה. מומלץ להשתמש בסרגל חיפוש אם החיפוש הוא המוקד העיקרי של האפליקציה.
משטח API
כדי להטמיע סרגלי חיפוש, משתמשים ב-SearchBar composable. הפרמטרים העיקריים של הרכיב הזה שניתן להרכבה כוללים את הפרמטרים הבאים:
-
inputField: הגדרה של שדה הקלט בסרגל החיפוש. בדרך כלל נעשה שימוש ב-SearchBarDefaults.InputField, שמאפשרת התאמה אישית של:-
query: טקסט השאילתה שיוצג בשדה הקלט. -
onQueryChange: Lambda לטיפול בשינויים במחרוזת השאילתה.
-
-
expanded: ערך בוליאני שמציין אם סרגל החיפוש מורחב כדי להציג הצעות או תוצאות מסוננות.
onExpandedChange: פונקציית Lambda לטיפול בשינויים במצב המורחב של התפריט הנפתח.
content: התוכן של סרגל החיפוש הזה שיוצגו מתחתיו תוצאות החיפוש שלinputField.
סרגל חיפוש עם הצעות
בקטע הקוד הזה מוצגת הטמעה בסיסית של SearchBar עם הצעות:
@OptIn(ExperimentalMaterial3Api::class) @Composable fun SimpleSearchBar( textFieldState: TextFieldState, onSearch: (String) -> Unit, searchResults: List<String>, modifier: Modifier = Modifier ) { // Controls expansion state of the search bar var expanded by rememberSaveable { mutableStateOf(false) } Box( modifier .fillMaxSize() .semantics { isTraversalGroup = true } ) { SearchBar( modifier = Modifier .align(Alignment.TopCenter) .semantics { traversalIndex = 0f }, inputField = { SearchBarDefaults.InputField( query = textFieldState.text.toString(), onQueryChange = { textFieldState.edit { replace(0, length, it) } }, onSearch = { onSearch(textFieldState.text.toString()) expanded = false }, expanded = expanded, onExpandedChange = { expanded = it }, placeholder = { Text("Search") } ) }, expanded = expanded, onExpandedChange = { expanded = it }, ) { // Display search results in a scrollable column Column(Modifier.verticalScroll(rememberScrollState())) { searchResults.forEach { result -> ListItem( headlineContent = { Text(result) }, modifier = Modifier .clickable { textFieldState.edit { replace(0, length, result) } expanded = false } .fillMaxWidth() ) } } } } }
נקודות עיקריות לגבי הקוד
-
rememberSaveableמוודא שהמצב של סרגל החיפוש (מורחב או מכווץ) נשמר גם אחרי שינויים בהגדרות. הערך שנשמר נכתב לחבילתsavedInstanceStateשל Activity המארח לפני ש-Activity מושמד במהלך שינוי בהגדרות. - מקש הצירוף
semanticsשולט בסדר ההעברה של TalkBack.- ההגדרה
isTraversalGroupמוגדרת ל-Boxכדי לקבץ את כל רכיבי ה-Composable ברמת הצאצא. - המאפיין
traversalIndexמוגדר כדי לציין את הסדר שבו TalkBack קורא מידע על נגישות מכל קבוצת עמיתים. TalkBack קורא מידע על נגישות של עמית עם ערך שלילי, כמו-1, לפני עמית עם ערך חיובי, כמו1. מכיוון שהערך הוא מספר עשרוני, אפשר להגדיר סדר מותאם אישית של הרבה עמיתים על ידי הגדרת ערכים בין-1.0ל-1.0בכל עמית.
- ההגדרה
- האלמנט
SearchBarמכילinputFieldלקלט של המשתמש ו-Columnלהצגת הצעות לחיפוש.-
SearchBarDefaults.InputFieldיוצר את שדה הקלט ומטפל בשינויים בשאילתת המשתמש. - הרכיב
onQueryChangeמטפל בקלט הטקסט ומעדכן את המצב בכל פעם שהטקסט בשדה הקלט משתנה. - המצב של
The expandedקובע את החשיפה של רשימת ההצעות.
-
-
searchResults.forEach { result -> … }חוזר על הפעולה ברשימהsearchResultsויוצרListItemלכל תוצאה.- כשלוחצים על
ListItem, המערכת מעדכנת אתtextFieldState, מכווצת את סרגל החיפוש וממלאת אתtextFieldבתוצאת החיפוש שנבחרה.
- כשלוחצים על
התוצאה
סרגל חיפוש עם רשימה מסוננת
בדוגמה הזו מוצג SearchBar שמסנן רשימה על סמך שאילתת החיפוש של המשתמש:
@OptIn(ExperimentalMaterial3Api::class) @Composable fun CustomizableSearchBar( query: String, onQueryChange: (String) -> Unit, onSearch: (String) -> Unit, searchResults: List<String>, onResultClick: (String) -> Unit, modifier: Modifier = Modifier, // Customization options placeholder: @Composable () -> Unit = { Text("Search") }, leadingIcon: @Composable (() -> Unit)? = { Icon(Icons.Default.Search, contentDescription = "Search") }, trailingIcon: @Composable (() -> Unit)? = null, supportingContent: (@Composable (String) -> Unit)? = null, leadingContent: (@Composable () -> Unit)? = null, ) { // Track expanded state of search bar var expanded by rememberSaveable { mutableStateOf(false) } Box( modifier .fillMaxSize() .semantics { isTraversalGroup = true } ) { SearchBar( modifier = Modifier .align(Alignment.TopCenter) .semantics { traversalIndex = 0f }, inputField = { // Customizable input field implementation SearchBarDefaults.InputField( query = query, onQueryChange = onQueryChange, onSearch = { onSearch(query) expanded = false }, expanded = expanded, onExpandedChange = { expanded = it }, placeholder = placeholder, leadingIcon = leadingIcon, trailingIcon = trailingIcon ) }, expanded = expanded, onExpandedChange = { expanded = it }, ) { // Show search results in a lazy column for better performance LazyColumn { items(count = searchResults.size) { index -> val resultText = searchResults[index] ListItem( headlineContent = { Text(resultText) }, supportingContent = supportingContent?.let { { it(resultText) } }, leadingContent = leadingContent, colors = ListItemDefaults.colors(containerColor = Color.Transparent), modifier = Modifier .clickable { onResultClick(resultText) expanded = false } .fillMaxWidth() .padding(horizontal = 16.dp, vertical = 4.dp) ) } } } } }
נקודות עיקריות לגבי הקוד
- הפונקציה
onQueryChangelambda נקראת בכל פעם שהמשתמש מקליד או מוחק טקסט בסרגל החיפוש. -
SearchBarDefaults.InputFieldמכיל את התגleadingIcon, שמוסיף סמל חיפוש לתחילת שדה הקלט, ואת התגtrailingIcon, שמוסיף סמל של 'אפשרויות נוספות' לסוף שדה הקלט. כאן אפשר לספק למשתמש אפשרויות מיון וסינון. - הפונקציה
onSearch = { … }קוראת לפונקציית ה-lambdaonSearchומכווצת את סרגל החיפוש כששולחים את החיפוש. LazyColumnמטפל ביעילות במספר גדול של תוצאות חיפוש. הוא מבצע איטרציה ברשימהsearchResultsומציג כל תוצאה כ-ListItem.- כל קומפוזבילי
ListItemמציג את הטקסט של הפריט, טקסט שמציג מידע נוסף וסמל כוכב כ-leadingContentשל הפריט. בדוגמה הזו, מוצגת אפשרות להוסיף את הפריט למועדפים. - לוגיקת הסינון מפורטת ב-
CustomizableSearchBarExampleבקוד המקור המלא ב-GitHub.
התוצאה
מקורות מידע נוספים
- Material Design: סרגל החיפוש