https://github.com/aquariuslt/lbs-tencent-typings

lbs.qq.com JavaScript API V2 type definitons
https://github.com/aquariuslt/lbs-tencent-typings

Last synced: 24 days ago
JSON representation

lbs.qq.com JavaScript API V2 type definitons

• Host: GitHub
• URL: https://github.com/aquariuslt/lbs-tencent-typings
• Owner: aquariuslt
• Created: 2018-08-01T17:31:12.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-14T06:17:53.000Z (6 months ago)
• Last Synced: 2024-05-14T07:33:11.009Z (6 months ago)
• Size: 302 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tencent Location JavaScript API V2 Type Definitions 

[![npm](https://img.shields.io/npm/v/lbs-tencent-typings.svg)](https://www.npmjs.com/package/lbs-tencent-typings)

## Background

This is an 的Type Definitions of  [QQMaps - JavaScript API](http://lbs.qq.com/javascript_v2/doc/) V2 .

## Road Map

- Provide Complete Type Definitions (100%)

- Provide Complete Type Definitions with Comments (0%)

- Pure API Example (50%)

- UI Framework Component Example

- Typing Tests

## Usage

### Installation

```bash

yarn add -D lbs-tencent-typings

```

### Screen Shot

![Application Code](./docs/imgs/search-service-typings.png)

![Type Definitions](./docs/imgs/search-service-definitions.png)

## Advanced: ESLint Configuration

如果项目中使用了`eslint-loader` + 不允许未经定义的全局变量, 可以通过在引入修改这份typings之后, 修改你的ESLint配置.

具体改动为: 在ESLint配置文件(例如`.eslintrc`)中定义`globals`,在里面添加`qq`这个namespace

```json

{

  "globals": {

      "qq": true

    }

}

```

## Advanced: API Usage Examples

为此, 写了一个使用**create-react-app** + **antd** 的 autocomplete 组件快速发开的, 脚本加载API和地点搜索补全功能.

详见Demo页面: [LBS Tencent Typings Sample](https://blog.aquariuslt.com/lbs-tencent-typings-sample/)

样例Repository: [lbs-tencent-typings-sample](https://github.com/aquariuslt/lbs-tencent-typings-sample)

### Pure Promise API Example

### React Component with API

### Vue Component with API