Gathering detailed insights and metrics for react-dadata
Gathering detailed insights and metrics for react-dadata
Gathering detailed insights and metrics for react-dadata
Gathering detailed insights and metrics for react-dadata
npm install react-dadata
Typescript
Module System
Node Version
NPM Version
78.5
Supply Chain
94.3
Quality
90.6
Maintenance
100
Vulnerability
100
License
TypeScript (99.22%)
CSS (0.66%)
HTML (0.11%)
Total Downloads
449,725
Last Day
667
Last Week
3,263
Last Month
11,225
Last Year
165,225
99 Stars
372 Commits
43 Forks
5 Watching
11 Branches
7 Contributors
Minified
Minified + Gzipped
Latest Version
2.27.4
Package Id
react-dadata@2.27.4
Unpacked Size
159.54 kB
Size
24.54 kB
File Count
73
NPM Version
10.4.0
Node Version
20.15.1
Publised On
15 Jan 2025
Cumulative downloads
Total Downloads
Last day
-11.9%
667
Compared to previous day
Last week
-8.8%
3,263
Compared to previous week
Last month
-34.3%
11,225
Compared to previous month
Last year
45.5%
165,225
Compared to previous year
4
19
Лёгкий (~5 kb min gzip), типизированный и настраиваемый React компонент для подсказок адресов, организаций, банков, ФИО и email с помощью сервиса DaData.ru
Предоставлена документация для 2.x, версия 1.x не поддерживается
pnpm add react-dadata
yarn add react-dadata
npm install react-dadata
1import { AddressSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<AddressSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
token | Да | string | Авторизационный токен DaData.ru |
value | Нет | DaDataSuggestion<*> | Текущее значение, если передается, то в поле ввода будет установлено значение value подсказки (если не указан defaultQuery ) а также при изменении будет менять значение в поле ввода. |
defaultQuery | Нет | string | Начальное значение поля ввода, имеет больший приоритет перед value . Используется только при монтировании компонента. |
delay | Нет | number | Задержка для debounce при отправке запроса в миллисекундах. По-умолчанию отсутствует, запрос отправляется на каждое изменение в поле ввода |
count | Нет | number | Количество подсказок, которое требуется получит от DaData. По-умолчанию: 10 |
autoload | Нет | boolean | Если true , то запрос на получение подсказок будет инициирован в фоне сразу, после монтирования компонента |
onChange | Нет | function(suggestion: DaDataSuggestion | Функция, вызываемая при выборе подсказки |
minChars | Нет | number | Минимальное количество символов для отправки запроса к DaData. По умолчанию не задан, то есть подсказки запрашиваются на каждый ввод |
inputProps | Нет | Object of HTMLInputElement Props | любые стандартные пропсы для input. Свойство value игнорируется. Используйте его для передачи инпуту определенных атрибутов или для отслеживания событий |
hintText | Нет | ReactNode | Если передано, отображается в виде подсказки над списком подсказок |
renderOption | Нет | function(suggestion: DaDataSuggestion | Реализуйте этот callback, чтобы вернуть компонент для отображения подсказки |
url | Нет | string | Если передан, запросы будут выполняться на этот URL (полезно, если используется прокси или коробочная версия на своем сервере) |
containerClassName | Нет | string | CSS класс для контейнера компонента, если не передан, используется класс для стилей из коробки. |
suggestionClassName | Нет | string | CSS класс для компонента подсказки в списке, если не передан, используется класс для стилей из коробки. |
currentSuggestionClassName | Нет | string | CSS класс который добавляется к компоненту текущей выбранной подсказки в списке, если не передан, используется класс для стилей из коробки. |
hintClassName | Нет | string | CSS класс блока текста-пояснения над подсказками, если не передан, используется класс для стилей из коробки. |
highlightClassName | Нет | string | CSS класс элемента, подсвечивающего совпадения при наборе, если не передан, используется класс для стилей из коробки. |
customInput | Нет | Element or string | Кастомный компонент поля ввода, например от Styled Components |
selectOnBlur | Нет | boolean | Если true , то при потере фокуса будет выбрана первая подсказка из списка |
uid | Нет | string | Уникальный ID который используется внутри компонента для связывания элементов при помощи aria атрибутов |
httpCache | Нет | boolean | Необходимо ли кешировать HTTP-запросы |
httpCacheTtl | Нет | number | Время жизни кеша HTTP-запросов (в миллисекундах). Значение по умолчанию - 10 минут |
Поскольку компонент классовый, он поддерживает вызов методов с помощью ref
.
1import React, { useRef } from 'react'; 2import { AddressSuggestions } from 'react-dadata'; 3import 'react-dadata/dist/react-dadata.css'; 4 5//... 6 7const suggestionsRef = useRef<AddressSuggestions>(null); 8const handleClick = () => { 9 if (suggestionsRef.current) { 10 suggestionsRef.current.setInputValue('Тут пример запроса'); 11 } 12}; 13 14//... 15 16<AddressSuggestions ref={suggestionsRef} token="API_KEY" /> 17<button onClick={handleClick}>Изменить поле ввода</button>
Вызывает событие focus
на поле ввода
Устанавливает указанный текст в поле ввода
1import { AddressSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<AddressSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterLanguage | Нет | ru | en | Язык подсказок в ответе (по умолчанию ru ) |
filterFromBound | Нет | string | Сужение области поиска, параметр from_bound в запросе |
filterToBound | Нет | string | Сужение области поиска, параметр to_bound в запросе |
filterLocations | Нет | array | Сужение области поиска, параметр locations в запросе |
filterLocationsBoost | Нет | array | Указание приоритета города, параметр locations_boost в запросе |
filterRestrictValue | Нет | bool | Передача параметра restrict_value в запросе |
1import { PartySuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<PartySuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterStatus | Нет | array | Фильтр по статусу организации, параметр status в запросе |
filterType | Нет | string | Фильтр по типу организации, параметр type в запросе |
filterOkved | Нет | string[] | Фильтр по ОКВЭД |
filterLocations | Нет | array | Сужение области поиска, параметр locations в запросе |
filterLocationsBoost | Нет | array | Указание приоритета города, параметр locations_boost в запросе |
1import { PartyBelarusSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<PartyBelarusSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterStatus | Нет | DaDataPartyBelarusStatus[] | Фильтр по статусу организации, параметр status в запросе |
filterType | Нет | DaDataPartyType[] | Фильтр по типу организации, параметр type в запросе |
1import { PartyKazakhstanSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<PartyKazakhstanSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterType | Нет | DaDataPartyKazakhstanType[] | Фильтр по типу организации, параметр type в запросе |
1import { BankSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<BankSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterStatus | Нет | array | Фильтр по статусу банка, параметр status в запросе |
filterType | Нет | string | Фильтр по типу банка, параметр type в запросе |
filterLocations | Нет | array | Сужение области поиска, параметр locations в запросе |
filterLocationsBoost | Нет | array | Указание приоритета города, параметр locations_boost в запросе |
1import { FioSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<FioSuggestions token="API_KEY" value={value} onChange={setValue} />;
Свойство | Обязательный | Тип | Описание |
---|---|---|---|
filterGender | Нет | UNKNOWN , MALE или FEMALE | Фильтр по полу |
filterParts | Нет | string[] | Подсказки по части ФИО |
1import { EmailSuggestions } from 'react-dadata'; 2import 'react-dadata/dist/react-dadata.css'; 3 4const [value, setValue] = useState(); 5 6<EmailSuggestions token="API_KEY" value={value} onChange={setValue} />;
react-dadata
поставляется с опциональным CSS файлом, который из коробки неплохо выглядит и выполняет свои функции.
Чтобы использовать его, укажите этот CSS файл в импорте или создайте CSS файл у себя с нужными стилями.
1import { AddressSuggestions } from 'react-dadata'; 2 3// Импортируем CSS файл 4import 'react-dadata/dist/react-dadata.css'; 5 6// ... 7<AddressSuggestions token="API_KEY" value={value} onChange={setValue} />;
Обратите внимание, что ваш сборщик должен быть настроен соответствующим образом для обработки CSS файлов.
Если у вас в проекте используется CSS-in-JS решение, то вы должны передавать CSS классы в компонент с помощью пропсов:
inputProps.className
- для поля вводаcontainerClassName
- для контейнера компонентаsuggestionsClassName
- для блока с подсказкамиsuggestionClassName
- для блока с подсказкойcurrentSuggestionClassName
- для блока с текущей выделенной подсказкойhintClassName
- для блока с пояснениемhighlightClassName
- для тега mark
, которым выделяются совпадения с введенным текстомreact-dadata
написан на TypeScript, поэтому типы встроены.
1import React, { useState } from 'react'; 2import { AddressSuggestions, DaDataSuggestion, DaDataAddress } from 'react-dadata'; 3import 'react-dadata/dist/react-dadata.css'; 4 5const [value, setValue] = useState<DaDataSuggestion<DaDataAddress> | undefined>(); 6 7// Также можно воспользоваться готовым типом DaDataAddressSuggestion для адреса или DaDataPartySuggestion для организаций 8// import { DaDataAddressSuggestion } from 'react-dadata'; 9// const [value, setValue] = useState<DaDataAddressSuggestion | undefined>(); 10 11<AddressSuggestions token="API_KEY" value={value} onChange={setValue} />;
Prop aria-owns did not match...
Данная ошибка возникает при использовании серверного рендеринга. Под капотом, react-dadata
, следуя принципам
доступности, создает компонент с aria ролью "combobox", которому необходимо через обычные HTML идентификаторы связывать
различные элементы. При использовании SSR в виду текущей архитектуры компонента данные ID генерируются дважды
независимо: на сервере и на клиенте, из-за чего в момент регидратации React выявляет несовпадение этих идентификаторов.
Эта проблема решается довольно просто в функциональных компонентах, однако на данный момент у меня нет быстрого решения
этой проблемы.
Чтобы иметь возможность избавиться от данной ошибки при использовании SSR можно передавать пропс uid
, в которой вы
можете передать уникальный в рамках страницы строковый идентификатор.
Если заранее известно, сколько компонентов и в каких местах страницы будут располагаться, можно передавать в качестве идентификаторов понятные строки:
1<AddressSuggestions 2 token="API_KEY" 3 value={value} 4 onChange={setValue} 5 uid="dadata-address-order-page" 6/>;
Если вы уже обновились на React 18, то можно воспользоваться стандартным хуком useId
:
1const id = useId(); 2 3return ( 4 <AddressSuggestions 5 token="API_KEY" 6 value={value} 7 onChange={setValue} 8 uid={id} 9 /> 10);
The MIT License
Copyright (c) 2016 Vitaly Baev <ping@baev.dev>, baev.dev
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
21 commit(s) and 9 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
19 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More