Основные

type

Тип подсказок. Обязательный.

Тип: "name" | "address" | "bank" | "email" | "party" | string

token

API-ключ. Обязателен для пользователей «Дадаты».

Тип: string

По умолчанию: не задано.

Базовые настройки

minChars

Минимальная длина текста, после которой включаются подсказки.

Тип: number

По умолчанию: 1

deferRequestBy

Период ожидания перед отправкой запроса на сервер подсказок, в миллисекундах. Позволяет не перегружать сервер запросами, если пользователь очень быстро печатает.

Тип: number

По умолчанию: 100

autoSelectFirst

Автоматически выбирать первую подсказку в списке.

Тип: boolean

По умолчанию: false

hint

Поясняющий текст, который показывается в выпадающем списке над подсказками. При hint=false текст показываться не будет.

Тип: string | false

По умолчанию: "Выберите вариант или продолжите ввод"

noSuggestionsHint

Поясняющий текст, который показывается, если для введённого запроса ничего не найдено. Текст зависит от типа подсказок. При noSuggestionsHint=false текст показываться не будет.

Тип: string | false

По умолчанию: "Неизвестное значение"

enrichmentEnabled

Обогащать подсказку при выборе (если обогащение возможно в зависимости от типа подсказок). Обогащение производится дополнительным запросом на сервер подсказок.

Тип: boolean

По умолчанию: true

params

Дополнительные параметры для передачи с запросом на сервер подсказок. Может быть или в виде объекта с параметрами, или функцией, принимающей запрос query и возвращающей объект параметров.

Тип:

Record<string, unknown>

| (query: string) =>
Record<string, unknown>

По умолчанию: не задано.

Настройки API

serviceUrl

Базовый URL сервера подсказок.

Тип: string

По умолчанию: https://suggestions.dadata.ru/suggestions/api/4_1/rs

url

Полный url для запроса подсказок. Если не передан, то конструируется на основе serviceUrl:

{serviceUrl}/{method}/{type}

Тип: string

По умолчанию: не задано.

headers

Дополнительные HTTP-заголовки, которые необходимо передать на сервер. Может быть или в виде объекта с заголовками, или функцией, возвращающей этот объект.

Тип: Record<string, string> | (() => Record<string, string>)

По умолчанию: не задано.

timeout

Таймаут для запросов к серверу подсказок в миллисекундах. Если запрос не успевает выполниться за указанное время, то будет отменен.

Тип: number

По умолчанию: 3000

partner

Идентификатор в партнерской программе.

Тип: string

По умолчанию: не задано.

preventBadQueries

Предотвращает отправку запросов к серверу, если по предыдущему запросу не было найдено подсказок. Например, если по запросу "мос" не было подсказок, то запрос "моск" не будет отправлен.

Тип: boolean

По умолчанию: false

noCache

Отключает кэширование ответов сервера.

Тип: boolean

По умолчанию: false

Настройки по типам подсказок

geolocation

Для подсказок по адресам (type=address), банкам (type=bank) и организациям (type=party). Определяет местоположение по IP и устанавливает его в качестве приоритетного при поиске подсказок (locations_boost).

Если в параметрах передан собственный параметр locations_boost - перезаписывает его.

Тип: boolean

По умолчанию: true

suggest_local

Для подсказок по email (type=email). Включает подсказки по локальной (до символа @) части email-адреса.

Тип: boolean

По умолчанию: true

Настройки UI

mobileWidth

Максимальная ширина экрана в px, при которой будет применен вид, адаптированный для мобильных устройств.

Тип: number

По умолчанию: 600

closeDelay

Время в миллисекундах, на которое будет отложено очищение списка подсказок при закрытии.

Позволяет реализовать анимацию закрытия списка. Открытый список с подсказками получает css-класс suggestions-wrapper--active, при закрытии активный класс удаляется, и по истечению closeDelay список очищается.

Тип: number

По умолчанию: не задано.

scrollOnFocus

Прокручивать текстовое поле к верхней границе экрана при фокусе. Если настройка включена, действует только на мобильных устройствах.

Тип: boolean

По умолчанию: false

tabDisabled

Предотвратить поведение по умолчанию при нажатии Tab в текстовом поле.

Тип: boolean

По умолчанию: false

triggerSelectOnBlur

Автоматически подставлять подходящую подсказку из списка, когда текстовое поле теряет фокус.

Тип: boolean

По умолчанию: true

triggerSelectOnEnter

Автоматически подставлять подходящую подсказку из списка при нажатии на Enter.

Тип: boolean

По умолчанию: true

triggerSelectOnSpace

Автоматически подставлять подходящую подсказку из списка при нажатии на пробел.

Тип: boolean

По умолчанию: false