{"id":24525895,"url":"https://github.com/vitalybaev/react-dadata","last_synced_at":"2025-10-25T00:44:06.728Z","repository":{"id":24208030,"uuid":"100871357","full_name":"vitalybaev/react-dadata","owner":"vitalybaev","description":"React-компонент для подсказов адресов, организаций и банков с помощью DaData.ru","archived":false,"fork":false,"pushed_at":"2024-02-22T12:08:16.000Z","size":2378,"stargazers_count":88,"open_issues_count":30,"forks_count":40,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-03-15T05:11:34.449Z","etag":null,"topics":["address-autocomplete","dadata","react","suggestions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vitalybaev.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-20T15:41:20.000Z","updated_at":"2024-06-18T16:41:30.929Z","dependencies_parsed_at":"2024-06-18T16:41:19.865Z","dependency_job_id":"004e01c5-aba6-42ec-a43b-fa55e59e863f","html_url":"https://github.com/vitalybaev/react-dadata","commit_stats":{"total_commits":265,"total_committers":7,"mean_commits":"37.857142857142854","dds":0.4716981132075472,"last_synced_commit":"19b81cde2f2d789fcd9e8d25f4a395a7f4bb793b"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalybaev%2Freact-dadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalybaev%2Freact-dadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalybaev%2Freact-dadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalybaev%2Freact-dadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitalybaev","download_url":"https://codeload.github.com/vitalybaev/react-dadata/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430868,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address-autocomplete","dadata","react","suggestions"],"created_at":"2025-01-22T05:29:12.185Z","updated_at":"2025-10-25T00:44:06.668Z","avatar_url":"https://github.com/vitalybaev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Dadata\n\n[![Coverage Status](https://coveralls.io/repos/github/vitalybaev/react-dadata/badge.svg)](https://coveralls.io/github/vitalybaev/react-dadata)\n![npm](https://img.shields.io/npm/dt/react-dadata)\n[![dependencies](https://img.shields.io/librariesio/release/npm/react-dadata/2.16.0)](https://www.npmjs.com/package/react-dadata)\n[![npm package](https://img.shields.io/npm/v/react-dadata.svg)](https://www.npmjs.com/package/react-dadata)\n[![npm downloads](https://img.shields.io/npm/dm/react-dadata.svg)](https://www.npmjs.com/package/react-dadata)\n[![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-dadata)](https://bundlephobia.com/result?p=react-dadata)\n![licence](https://img.shields.io/npm/l/react-dadata)\n\nЛёгкий (**~5 kb min gzip**), типизированный и настраиваемый React компонент для подсказок **адресов, организаций,\nбанков, ФИО и email** с помощью сервиса DaData.ru\n\n[Демонстрация](https://vitalybaev.github.io/react-dadata/)\n\n**Предоставлена документация для 2.x, версия 1.x не поддерживается**\n\n## Содержание\n\n* [Внешний вид](#%D0%B2%D0%BD%D0%B5%D1%88%D0%BD%D0%B8%D0%B9-%D0%B2%D0%B8%D0%B4)\n * [Адреса](#%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0)\n * [Организации](#%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8)\n * [Банки](#%D0%B1%D0%B0%D0%BD%D0%BA%D0%B8)\n* [Установка](#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0)\n* [Пример использования](#%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80-%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)\n* [Параметры](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B)\n * [Общие параметры](#%D0%BE%D0%B1%D1%89%D0%B8%D0%B5-%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B)\n* [Методы](#%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D1%8B)\n* [Типы подсказок и примеры](#%D1%82%D0%B8%D0%BF%D1%8B-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BE%D0%BA-%D0%B8-%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B)\n * [Адреса](#%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0-1)\n * [Организации](#%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8-1)\n * [Банки](#%D0%B1%D0%B0%D0%BD%D0%BA%D0%B8-1)\n * [ФИО](#%D1%84%D0%B8%D0%BE)\n * [Email](#email)\n* [Стилизация](#%D1%81%D1%82%D0%B8%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F)\n* [TypeScript](#typescript)\n* [Лицензия](#%D0%BB%D0%B8%D1%86%D0%B5%D0%BD%D0%B7%D0%B8%D1%8F)\n\n## Внешний вид\n\n### Адреса\n\n\u003cimg width=\"591\" alt=\"СReact DaData адреса\" src=\"https://user-images.githubusercontent.com/724423/89572756-3e18d280-d832-11ea-8e52-08d35ad8abc0.gif\"\u003e\n\n### Организации\n\n\u003cimg width=\"587\" alt=\"React DaData организации\" src=\"https://user-images.githubusercontent.com/724423/84180388-199db580-aa90-11ea-8276-548dcaff641d.png\"\u003e\n\n### Банки\n\n\u003cimg width=\"585\" alt=\"React DaData банки\" src=\"https://user-images.githubusercontent.com/724423/84180460-320dd000-aa90-11ea-9a16-62c9e230052d.png\"\u003e\n\n## Установка\n\n### pnpm\n\n```\npnpm add react-dadata\n```\n\n### yarn\n\n```\nyarn add react-dadata\n```\n\n### npm\n\n```\nnpm install react-dadata\n```\n\n## Пример использования\n\n```jsx\nimport { AddressSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cAddressSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n## Параметры\n\n### Общие параметры\n\n| Свойство | Обязательный | Тип | Описание |\n|----------------------------|--------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| token | Да | string | Авторизационный токен DaData.ru |\n| value | Нет | DaDataSuggestion\u003c\\*\u003e | Текущее значение, если передается, то в поле ввода будет установлено значение `value` подсказки (если не указан `defaultQuery`) а также при изменении будет менять значение в поле ввода. |\n| defaultQuery | Нет | string | Начальное значение поля ввода, имеет больший приоритет перед `value`. Используется только при монтировании компонента. |\n| delay | Нет | number | Задержка для debounce при отправке запроса в миллисекундах. По-умолчанию отсутствует, запрос отправляется на каждое изменение в поле ввода |\n| count | Нет | number | Количество подсказок, которое требуется получит от DaData. По-умолчанию: **10** |\n| autoload | Нет | boolean | Если `true`, то запрос на получение подсказок будет инициирован в фоне сразу, после монтирования компонента |\n| onChange | Нет | function(suggestion: DaDataSuggestion\u003cType\u003e) | Функция, вызываемая при выборе подсказки |\n| minChars | Нет | number | Минимальное количество символов для отправки запроса к DaData. По умолчанию не задан, то есть подсказки запрашиваются на каждый ввод |\n| inputProps | Нет | Object of HTMLInputElement Props | любые стандартные пропсы для input. Свойство `value` игнорируется. Используйте его для передачи инпуту определенных атрибутов или для отслеживания событий |\n| hintText | Нет | ReactNode | Если передано, отображается в виде подсказки над списком подсказок |\n| renderOption | Нет | function(suggestion: DaDataSuggestion\u003cType\u003e) =\u003e ReactNode | Реализуйте этот callback, чтобы вернуть компонент для отображения подсказки |\n| url | Нет | string | Если передан, запросы будут выполняться на этот URL (полезно, если используется прокси или коробочная версия на своем сервере) |\n| containerClassName | Нет | string | CSS класс для контейнера компонента, если не передан, используется класс для стилей из коробки. |\n| suggestionClassName | Нет | string | CSS класс для компонента подсказки в списке, если не передан, используется класс для стилей из коробки. |\n| currentSuggestionClassName | Нет | string | CSS класс который добавляется к компоненту текущей выбранной подсказки в списке, если не передан, используется класс для стилей из коробки. |\n| hintClassName | Нет | string | CSS класс блока текста-пояснения над подсказками, если не передан, используется класс для стилей из коробки. |\n| highlightClassName | Нет | string | CSS класс элемента, подсвечивающего совпадения при наборе, если не передан, используется класс для стилей из коробки. |\n| customInput | Нет | Element or string | Кастомный компонент поля ввода, например от Styled Components |\n| selectOnBlur | Нет | boolean | Если `true`, то при потере фокуса будет выбрана первая подсказка из списка |\n| uid | Нет | string | Уникальный ID который используется внутри компонента для связывания элементов при помощи aria атрибутов |\n| httpCache | Нет | boolean | Необходимо ли кешировать HTTP-запросы |\n| httpCacheTtl | Нет | number | Время жизни кеша HTTP-запросов (в миллисекундах). Значение по умолчанию - 10 минут |\n\n## Методы\n\nПоскольку компонент классовый, он поддерживает вызов методов с помощью `ref`.\n\n```tsx\nimport React, { useRef } from 'react';\nimport { AddressSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\n//...\n\nconst suggestionsRef = useRef\u003cAddressSuggestions\u003e(null);\nconst handleClick = () =\u003e {\n if (suggestionsRef.current) {\n suggestionsRef.current.setInputValue('Тут пример запроса');\n }\n};\n\n//...\n\n\u003cAddressSuggestions ref={suggestionsRef} token=\"API_KEY\" /\u003e\n\u003cbutton onClick={handleClick}\u003eИзменить поле ввода\u003c/button\u003e\n```\n\n### focus()\n\nВызывает событие `focus` на поле ввода\n\n### setInputValue(value: string | undefined)\n\nУстанавливает указанный текст в поле ввода\n\n## Типы подсказок и примеры\n\n### Адреса\n\n```jsx\nimport { AddressSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cAddressSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента адресов\n\n| Свойство | Обязательный | Тип | Описание |\n|----------------------| ------------ |--------------|------------------------------------------------------------------|\n| filterLanguage | Нет | `ru` \\| `en` | Язык подсказок в ответе (по умолчанию `ru`) |\n| filterFromBound | Нет | string | Сужение области поиска, параметр `from_bound` в запросе |\n| filterToBound | Нет | string | Сужение области поиска, параметр `to_bound` в запросе |\n| filterLocations | Нет | array | Сужение области поиска, параметр `locations` в запросе |\n| filterLocationsBoost | Нет | array | Указание приоритета города, параметр `locations_boost` в запросе |\n| filterRestrictValue | Нет | bool | Передача параметра `restrict_value` в запросе |\n\n### Организации в России 🇷🇺\n\n```jsx\nimport { PartySuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cPartySuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента организаций в России\n\n| Свойство | Обязательный | Тип | Описание |\n|----------------------|--------------|-----------|----------------------------------------------------------------|\n| filterStatus | Нет | array | Фильтр по статусу организации, параметр status в запросе |\n| filterType | Нет | string | Фильтр по типу организации, параметр type в запросе |\n| filterOkved | Нет | string[] | Фильтр по ОКВЭД |\n| filterLocations | Нет | array | Сужение области поиска, параметр locations в запросе |\n| filterLocationsBoost | Нет | array | Указание приоритета города, параметр locations_boost в запросе |\n\n### Организации в Беларуси 🇧🇾\n\n```jsx\nimport { PartyBelarusSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cPartyBelarusSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента организаций в Беларуси\n\n| Свойство | Обязательный | Тип | Описание |\n|----------------------|--------------|-----------|----------------------------------------------------------------|\n| filterStatus | Нет | `DaDataPartyBelarusStatus[]` | Фильтр по статусу организации, параметр status в запросе |\n| filterType | Нет | `DaDataPartyType[]` | Фильтр по типу организации, параметр type в запросе |\n\n### Организации в Казахстане 🇰🇿\n\n```jsx\nimport { PartyKazakhstanSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cPartyKazakhstanSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента организаций в Казахстане\n\n| Свойство | Обязательный | Тип | Описание |\n|----------------------|--------------|-----------|----------------------------------------------------------------|\n| filterType | Нет | `DaDataPartyKazakhstanType[]` | Фильтр по типу организации, параметр type в запросе |\n\n\n### Банки\n\n```jsx\nimport { BankSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cBankSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента банков\n\n| Свойство | Обязательный | Тип | Описание |\n| -------------------- | ------------ | ------ | -------------------------------------------------------------- |\n| filterStatus | Нет | array | Фильтр по статусу банка, параметр status в запросе |\n| filterType | Нет | string | Фильтр по типу банка, параметр type в запросе |\n| filterLocations | Нет | array | Сужение области поиска, параметр locations в запросе |\n| filterLocationsBoost | Нет | array | Указание приоритета города, параметр locations_boost в запросе |\n\n### ФИО\n\n```jsx\nimport { FioSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cFioSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n#### Дополнительные параметры для компонента ФИО\n\n| Свойство | Обязательный | Тип | Описание |\n| ------------ | ------------ | ------------------------------ | ---------------------- |\n| filterGender | Нет | `UNKNOWN`, `MALE` или `FEMALE` | Фильтр по полу |\n| filterParts | Нет | string[] | Подсказки по части ФИО |\n\n### Email\n\n```jsx\nimport { EmailSuggestions } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState();\n\n\u003cEmailSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n## Стилизация\n\n`react-dadata` поставляется с опциональным CSS файлом, который из коробки неплохо выглядит и выполняет свои функции.\nЧтобы использовать его, укажите этот CSS файл в импорте или создайте CSS файл у себя с нужными стилями.\n\n```jsx\nimport { AddressSuggestions } from 'react-dadata';\n\n// Импортируем CSS файл\nimport 'react-dadata/dist/react-dadata.css';\n\n// ...\n\u003cAddressSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n**Обратите внимание**, что ваш сборщик должен быть настроен соответствующим образом для обработки CSS файлов.\n\nЕсли у вас в проекте используется CSS-in-JS решение, то вы должны передавать CSS классы в компонент с помощью пропсов:\n\n- `inputProps.className` - для поля ввода\n- `containerClassName` - для контейнера компонента\n- `suggestionsClassName` - для блока с подсказками\n- `suggestionClassName` - для блока с подсказкой\n- `currentSuggestionClassName` - для блока с текущей выделенной подсказкой\n- `hintClassName` - для блока с пояснением\n- `highlightClassName` - для тега `mark`, которым выделяются совпадения с введенным текстом\n\n## TypeScript\n\n`react-dadata` написан на TypeScript, поэтому типы встроены.\n\n```tsx\nimport React, { useState } from 'react';\nimport { AddressSuggestions, DaDataSuggestion, DaDataAddress } from 'react-dadata';\nimport 'react-dadata/dist/react-dadata.css';\n\nconst [value, setValue] = useState\u003cDaDataSuggestion\u003cDaDataAddress\u003e | undefined\u003e();\n\n// Также можно воспользоваться готовым типом DaDataAddressSuggestion для адреса или DaDataPartySuggestion для организаций\n// import { DaDataAddressSuggestion } from 'react-dadata';\n// const [value, setValue] = useState\u003cDaDataAddressSuggestion | undefined\u003e();\n\n\u003cAddressSuggestions token=\"API_KEY\" value={value} onChange={setValue} /\u003e;\n```\n\n## Ошибка в консоли `Prop aria-owns did not match...`\n\nДанная ошибка возникает при использовании серверного рендеринга. Под капотом, `react-dadata`, следуя принципам\nдоступности, создает компонент с aria ролью \"combobox\", которому необходимо через обычные HTML идентификаторы связывать\nразличные элементы. При использовании SSR в виду текущей архитектуры компонента данные ID генерируются дважды\nнезависимо: на сервере и на клиенте, из-за чего в момент регидратации React выявляет несовпадение этих идентификаторов.\nЭта проблема решается довольно просто в функциональных компонентах, однако на данный момент у меня нет быстрого решения\nэтой проблемы.\n\nЧтобы иметь возможность избавиться от данной ошибки при использовании SSR можно передавать пропс `uid`, в которой вы\nможете передать _уникальный в рамках страницы_ строковый идентификатор.\n\nЕсли заранее известно, сколько компонентов и в каких местах страницы будут располагаться, можно передавать в качестве\nидентификаторов понятные строки:\n\n```tsx\n\u003cAddressSuggestions\n token=\"API_KEY\"\n value={value}\n onChange={setValue}\n uid=\"dadata-address-order-page\"\n/\u003e;\n```\n\nЕсли вы уже обновились на React 18, то можно воспользоваться стандартным хуком `useId`:\n\n```tsx\nconst id = useId();\n\nreturn (\n \u003cAddressSuggestions\n token=\"API_KEY\"\n value={value}\n onChange={setValue}\n uid={id}\n /\u003e\n);\n```\n\n## Лицензия\n\n```\nThe MIT License\n\nCopyright (c) 2016 Vitaly Baev \u003cping@baev.dev\u003e, baev.dev\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n\n### TODO\n\n- В ближайшее время добавить подсказки для ФИО.\n- Увеличить покрытие тестов\n- Сайт с документацией\n- Если вам чего-то не хватает в текущем функционале - создавайте issue, попробуем помочь!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalybaev%2Freact-dadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitalybaev%2Freact-dadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalybaev%2Freact-dadata/lists"}