跳到主要内容

useLocation

地理位置

何时使用

当需使用地理位置时

API

const [
location,
{
get,
choose,
choosePOI,
open,
toggleUpdate,
on,
off,
},
] = useLocation(options?);

参数说明

参数说明类型默认值
options获取地理信息配置(若指定后面可与新的配置合并)ExcludeOption<Taro.getLocation.Option>-

返回值说明

返回值说明类型
location根据初始化配置获取的地理信息WithUndefind<Taro.getLocation.SuccessCallbackResult>
get获取当前的地理位置、速度(h5 支持)PromiseOptionalAction<Option, Taro.getLocation.SuccessCallbackResult>
choose打开地图选择位置PromiseOptionalAction<ExcludeOption<Taro.chooseLocation.Option>, Taro。chooseLocation.SuccessCallbackResult>
choosePOI打开地图选择位置PromiseWithoutOptionAction<Taro.choosePoi.SuccessCallbackResult>
toggleUpdate开启/关闭小程序进入前台(或后台)时接收位置消息PromiseParamsAction<(onOff?: boolean, background?: boolean) => void>
open使用微信内置地图查看位置PromiseAction<ExcludeOption<Taro.openLocation.Option>>
on监听实时地理位置变化事件(h5 支持)(callback: ChangeCallback | ChangErrorCallback, error?: boolean) => void
off取消监听实时地理位置变化事件(h5 支持)(callback: Callback | ChangErrorCallback, error?: boolean) => void

代码演示

Hook 支持度

微信小程序H5ReactNative
✔️✔️