UserLocation.md

<MapLibreGL.UserLocation />

Props

Prop	Type	Default	Required	Description
animated	boolean	true	false	Whether location icon is animated between updates
renderMode	"normal" | "native"	"normal"	false	Which render mode to use. Can either be normal or native
androidRenderMode	"normal" | "compass" | "gps"	none	false	native/android only render mode - normal: just a circle - compass: triangle with heading - gps: large arrow @platform android
visible	boolean	true	false	Whether location icon is visible
showsUserHeadingIndicator	boolean	false	false	Show or hide small arrow which indicates direction the device is pointing relative to north.
minDisplacement	number	0	false	Minimum amount of movement before GPS location is updated in meters
androidPreferredFramesPerSecond	number	none	false	Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX. @platform android
children	ReactElement | ReactElement[]	none	false	Custom location icon of type mapbox-gl-native components NOTE: Forking maintainer does not understand the above comment.

Methods

`setLocationManager({

running, }: { running: boolean; })`

Whether to start or stop listening to the locationManager

Notice, that listening will start automatically when
either onUpdate or visible are set

Arguments

Name	Type	Required	Description
`{
running,
}: {
running: boolean;
}`	{running:boolean;}	Yes	undefined

needsLocationManagerRunning()

If locationManager should be running