ui / com.mapbox.search.ui.view / SearchBottomSheetView

SearchBottomSheetView

class SearchBottomSheetView : FrameLayout, AttachedBehavior

View implements forward geocoding functionality. Also can add, edit or delete favorites.

Types

BottomSheetState

State of the bottom sheet.

enum class BottomSheetState

CollapsedStateAnchor

Anchor for the bottom sheet collapsed state, defines height of the bottom sheet when it is collapsed.

enum class CollapsedStateAnchor

Configuration

SearchBottomSheetView configuration class.

class Configuration : Parcelable

OnBottomSheetStateChangedListener

Listener for watching bottom sheet state changes events.

interface OnBottomSheetStateChangedListener

OnCategoryClickListener

Listener for category item click processing.

interface OnCategoryClickListener

OnFavoriteClickListener

Listener for favorite item click processing.

interface OnFavoriteClickListener

OnSearchResultClickListener

Listener for search result item click processing.

interface OnSearchResultClickListener

Constructors

<init>

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

Properties

isHideableByDrag

This property is responsible for possibility to toggle SearchBottomSheetView to hidden state by dragging down.

var isHideableByDrag: Boolean

state

The current state of the bottom sheet.

val state: BottomSheetState

Functions

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

addOnCategoryClickListener

Adds a listener to be notified of category clicks.

fun addOnCategoryClickListener(listener: OnCategoryClickListener): Unit

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

fun addOnCategoryClickListener(listener: (Category) -> Unit): Unit

addOnFavoriteClickListener

Adds a listener to be notified of clicks on favorites.

fun addOnFavoriteClickListener(listener: OnFavoriteClickListener): Unit

Experimental function, can be changed or removed in the next SDK releases. Adds a lambda to be notified of clicks on favorite.

fun addOnFavoriteClickListener(listener: (FavoriteRecord) -> Unit): Unit

addOnSearchResultClickListener

Adds a listener to be notified of clicks on search result.

fun addOnSearchResultClickListener(listener: OnSearchResultClickListener): Unit

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

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

expand

Switch SearchBottomSheetView to expanded state.

fun expand(): Unit

getBehavior

fun getBehavior(): Behavior<*>

handleOnBackPressed

Back button handler.

fun handleOnBackPressed(): Boolean

hide

Switch SearchBottomSheetView to hidden state, when 0% of it is visible on the screen.

fun hide(): Unit

initializeSearch

fun initializeSearch(savedInstanceState: Bundle?, configuration: Configuration): Unit

isHidden

Check if view is hidden in current moment.

fun isHidden(): Boolean

open

Switch SearchBottomSheetView to collapsed state, but when part of it is still visible.

fun open(): Unit

removeOnBottomSheetStateChangedListener

Removes a previously added listener.

fun removeOnBottomSheetStateChangedListener(listener: OnBottomSheetStateChangedListener): Unit

removeOnCategoryClickListener

Removes a previously added listener.

fun removeOnCategoryClickListener(listener: OnCategoryClickListener): Unit

removeOnFavoriteClickListener

Removes a previously added listener.

fun removeOnFavoriteClickListener(listener: OnFavoriteClickListener): Unit

removeOnSearchResultClickListener

Removes a previously added listener.

fun removeOnSearchResultClickListener(listener: OnSearchResultClickListener): Unit

restorePreviousNonHiddenState

Restores previous view state if SearchBottomSheetView is currently in hidden state.

fun restorePreviousNonHiddenState(): Unit