ui / com.mapbox.search.ui.view.category / SearchCategoriesBottomSheetView

SearchCategoriesBottomSheetView

class SearchCategoriesBottomSheetView : FrameLayout, AttachedBehavior

View that implements category search. It notifies developers via listeners when a user clicks on a SearchResult, favorite record or wants to initiate a category search.

Types

BottomSheetState

State of the bottom sheet.

enum class BottomSheetState

CategoryLoadingStateListener

interface CategoryLoadingStateListener

OnBottomSheetStateChangedListener

Listener for watching bottom sheet state changes events.

interface OnBottomSheetStateChangedListener

OnCloseClickListener

interface OnCloseClickListener

OnSearchResultClickListener

interface OnSearchResultClickListener

Constructors

<init>

SearchCategoriesBottomSheetView(context: Context)
SearchCategoriesBottomSheetView(context: Context, attrs: AttributeSet?)
SearchCategoriesBottomSheetView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)
SearchCategoriesBottomSheetView(context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int)

Properties

state

The current state of the bottom sheet.

val state: BottomSheetState

Functions

addCategoryLoadingStateListener

Adds CategoryLoadingStateListener to know exactly when search started, failed or succeeded with some results.

fun addCategoryLoadingStateListener(listener: CategoryLoadingStateListener): Unit

addOnBottomSheetStateChangedListener

Adds a listener to be notified of bottom sheet events.

fun addOnBottomSheetStateChangedListener(listener: OnBottomSheetStateChangedListener): Unit

Experimental function, can be changed or removed in the next SDK releases. Adds a lambda to be notified of bottom sheet events.

fun addOnBottomSheetStateChangedListener(listener: (BottomSheetState, Boolean) -> Unit): Unit

addOnCloseClickListener

Adds a listener to be notified of close button click.

fun addOnCloseClickListener(listener: OnCloseClickListener): Unit

Experimental function, can be changed or removed in the next SDK releases. Adds a listener to be notified of close button click.

fun addOnCloseClickListener(listener: () -> Unit): Unit

addOnSearchResultClickListener

Adds a listener to be notified of search result clicks.

fun addOnSearchResultClickListener(listener: OnSearchResultClickListener): Unit

Experimental function, can be changed or removed in the next SDK releases. Adds a listener to be notified of search result clicks.

fun addOnSearchResultClickListener(listener: (SearchResult) -> Unit): Unit

cancelCategoryLoading

Cancel current category search.

fun cancelCategoryLoading(): Unit

handleOnBackPressed

Back button handler.

fun handleOnBackPressed(): Boolean

hide

Switch SearchCategoriesBottomSheetView to hidden state.

fun hide(): Unit

isHidden

Check if view is hidden in current moment.

fun isHidden(): Boolean

open

Switch SearchCategoriesBottomSheetView to opened state.

fun open(category: Category): Unit

removeCategoryLoadingStateListener

Removes a previously added CategoryLoadingStateListener.

fun removeCategoryLoadingStateListener(listener: CategoryLoadingStateListener): Unit

removeOnBottomSheetStateChangedListener

Removes a previously added listener.

fun removeOnBottomSheetStateChangedListener(listener: OnBottomSheetStateChangedListener): Unit

removeOnCloseClickListener

Removes a previously added OnCloseClickListener.

fun removeOnCloseClickListener(listener: OnCloseClickListener): Unit

removeOnSearchResultClickListener

Removes a previously added OnSearchResultClickListener.

fun removeOnSearchResultClickListener(listener: OnSearchResultClickListener): Unit

restorePreviousNonHiddenState

Restores previous view state for SearchCategoriesBottomSheetView with correctcategory.

fun restorePreviousNonHiddenState(category: Category): Unit