npm 包 react-select-geocoder 使用教程

阅读时长 7 分钟读完

简介

react-select-geocoder 是一个 React 组件,它提供了一个输入框和一个下拉框,在用户输入地址时将自动提示出匹配的地点。使用该组件可以方便地实现地址输入框的自动完成功能。

安装

可以通过 npm 安装 react-select-geocoder

使用

在组件中引入 react-select-geocoder,并将其加入界面中,代码如下:

-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- ------------------------

----- --- ------- --------------- -
  ------------------ -
    -------------
    ---------- - -
      --------- ----
    --
    ------------- - -------------------------
  -

  --------------- -
    --------------- --------- ----- ---
  -

  -------- -
    ------ -
      -----
        ---------
          ------------------------
          ------------------
        --
        ----------------------------- -- --------------------------------
      ------
    --
  -
-

------ ------- ----

上述代码中,onSelect 方法会在用户选择一个地点时被调用,将选择的地点存入组件的状态中。placeholder 属性指定了输入框中显示的占位符。

配置

react-select-geocoder 组件的配置项如下:

名称 描述 类型 默认值
onSelect 用户选择地点的回调函数 function () => {}
value 默认选中的地点 object or array null
inputTimeout 再次输入触发搜索的延迟时间 number 500
options 地点搜索的配置项,详见下文 object {}
cacheSize 缓存的最大数量 number 10
placeholder 输入框的占位符 string ''
className 组件的 CSS 类名 string ''
styles 组件样式的配置项,详见下文 object {}

options

options 对象中的配置项如下:

名称 描述 类型 默认值
accessToken Mapbox 开发者密钥 string 必需
placeholder 输入框的占位符 string 请输入地址
proximity 搜索时的中心位置 string or array undefined
autocomplete 是否自动完成 boolean true
bbox 搜索时的边界框 array null
types 搜索的地点类型 string or array address,poi

其中,accessToken 是 Mapbox 开发者密钥,必须要填写。proximitybboxtypes 的取值参见 Mapbox Geocoding API 的文档。

styles

styles 对象中的配置项如下:

名称 描述 类型
control 输入框和下拉框的样式 object
menu 下拉框的样式 object
option 下拉框选项的样式 object
group 下拉框选项组的样式 object
loadingMessage 加载地点时的提示消息的样式 object

这些配置项均为可选的,如果不想对某个样式进行修改,可以忽略它。

示例

下面是一个完整的使用示例,展示了如何使用其他配置项:

-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- ------------------------

----- --- ------- --------------- -
  ------------------ -
    -------------
    ---------- - -
      --------- ----
    --
    ------------- - -------------------------
  -

  --------------- -
    --------------- --------- ----- ---
  -

  -------- -
    ------ -
      -----
        ---------
          ------------------------
          ---------------------------
          -------------------
          ----------
            ------------ ---------------------------
            ------ ------
            ----- -------- ----- ------- ------
            ---------- -------- -----
          --
          ---------
            -------- -
              ---------------- --------
              ------------ -------
              ------------- ------
              -------- -----
            --
            ----- -
              ---------------- --------
              ------------- ------
              ---------- ---- --- --- ------- -- -- -------
              ---------- ------
              ------ ------
            --
            ------- -
              ---------------- --------
              -------- -----
            --
            ------ -
              --------- -------
              ----------- -------
              -------------- -------------
              -------- -----
            --
            --------------- -
              --------- -------
              ----------- -------
              -------- -----
            -
          --
          ------------------
          --------------
          --------------------
        --
        ----------------------------- -- --------------------------------
      ------
    --
  -
-

------ ------- ----

总结

通过本文的介绍,我们了解了 react-select-geocoder 的安装、使用、配置和样式设置。使用这个组件可以方便地实现地址输入框的自动完成功能。同时,我们也看到了 React 组件的使用方法,以及如何在 React 中使用其他库(如 Mapbox Geocoding API)。希望本文对你的前端学习、实践有所启发。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedae63b5cbfe1ea0610e28

纠错
反馈