2.0.0 • Published 4 years ago

react-dadata-suggestions-reactoutsideclick v2.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

react-dadata-suggestions

React-компонент для подсказок dadata.

С чего начать

Установка

npm i --save react-dadata-suggestions

страница на npm

Использование

Песочница

import React, { Component } from 'react';
import DadataSuggestions from 'react-dadata-suggestions';
import "react-dadata-suggestions/dist/styles.css";

const token = 'your_token';

class App extends Component {
  render() {
    return (
      <DadataSuggestions
        token={ token }
        onSelect={ (suggestion) => console.log(suggestion) }
      />
    );
  }
}

export default App;

Настройка

Пропсы

proptypedescriptionrequireddefault
tokenstringваш api токенtrue''
countintegerмаксимальное количество подсказок в спискеfalse10
deferRequestByintegerзадержка перед запросом в мсfalse300
placeholderstringfalse''
hintstringподсказка для пользователя в выпадающем спискеfalseВыберите вариант ниже или продолжите ввод
minCharsintegerминимальная длина запроса для обращения к apifalse3
geolocationbooleanПриоритет городу пользователя, только для адресовfalsetrue
servicestringДоступные значения: address, bank, fio, email, partyfalseaddress
highlightingboolподсветка совпавших слов в подсказкахfalsetrue
receivePropsBehaveLikeOnChangeboolсм. нижеfalsefalse
valueobjectэкземпляр подсказкиfalsenull
namestringимя инпутаfalsenull
readOnlyотметить инпут как readonlyfalse
disabledотметить инпут как disabledfalse
suggestionsFormatter (suggestion)functionкастомный форматтер для подсказок в спискеfalse
selectedSuggestionFormatter (suggestion)functionкастомный форматтер для выбранной подсказки (результат будет установле в качестве строки запроса)false
specialRequestOptionsobjectдополнительные параметры для тела запросаfalse
onSelect (suggestion)functionобработчик выбора подсказкиtrue
onChange (query)functionобработчик изменения запросаfalse
onError (error)functionобработчик ошибки обращения к apifalse
onBlurfunctionвызывается когда фокус пропадает с элементаfalse
onFocusfunctionвызывается при установке фокуса на элементfalse

Структуру подсказки можно подсмотреть в официальной документации к api dadata

  • receivePropsBehaveLikeOnChange - только для версий < 2.0. Изменяет поведениеcomponentWillReceiveProps. По умолчанию при обновлении пропсов просто сбрасывается стейт, если же значение установлено в true, то поведение componentWillReceiveProps совпадает с поведением onChange. С версии 2.0 это единственный вариант поведения.

Подсветка совпадений

Для кастомизации подсветки переопределите класс .suggestions-highlighting.

License

This project is licensed under the MIT License