Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xescoder committed Oct 7, 2014
1 parent 281a69a commit b201855
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ jQuery Kladr
Свойства объекта $.kladr
--------------------------------------------------------------------------------

* **url** - url сервиса, по-умолчанию [http://kladr-api.ru/api.php] [2].
* **url** - url сервиса, по умолчанию [http://kladr-api.ru/api.php] [2].
* **type** - перечисление используемых типов объектов. Список значений: *region (область, регион)*,
*district (район)*, *city (населённый пункт)*, *street (улица)*, *building (строение)*.
* **typeCode** - перечисление используемых типов населённых пунктов. Список значений: *city (город)*,
*settlement (посёлок)*, *village (деревня, село)*.
* **validate** *= function (query) {}* - выполняет проверку коррекстности объекта запроса.
* **validate** *= function (query) {}* - выполняет проверку корректности объекта запроса.
* **api** *= function(query, callback) {}* - непосредственно выполняет запрос к сервису.
В качестве параметров принимает объект запроса и функцию, которой
будет передан ответ сервиса.
Expand All @@ -31,44 +31,44 @@ jQuery Kladr
Свойства объекта $.kladr дополнительно устанавливаемые плагином
--------------------------------------------------------------------------------

* **setDefault** *= function (param1, param2) {}* - устанавливает значения по-умолчанию
* **setDefault** *= function (param1, param2) {}* - устанавливает значения по умолчанию
для параметров плагина. В качестве параметров принимает аналогично плагину либо объект
со списком изменяемых параметров, либо пару "параметр - новое значение параметра".
* **getDefault** *= function (param) {}* - возвращает значение по-умолчанию для параметра плагина.
* **getDefault** *= function (param) {}* - возвращает значение по умолчанию для параметра плагина.
В качестве параметра принимает название параметра плагина.
* **getInputs** *= function (selector) {}* - возвращает jQuery коллекцию полей ввода, к которым был
подключён плагин. В качетве параметра принимает селектор, DOM элемент или же объект jQuery, в котором
будет выполнен поиск соответствующих полей, по-умолчанию *body*.
подключён плагин. В качестве параметра принимает селектор, DOM элемент или же объект jQuery, в котором
будет выполнен поиск соответствующих полей, по умолчанию *body*.
* **buildAddress** *= function (objs) {}* - строит строку адреса на основании массива объектов КЛАДР.
* **getAddress** *= function (selector, build) {}* - возвращает строку адреса на основании полей ввода,
к которым был подключён плагин. Первый параметр аналогичен параметру функции *getInputs*. В качестве второго
параметра принимает функцию, которой будет собираться строка адреса, по-умолчанию *buildAddress*.
параметра принимает функцию, которой будет собираться строка адреса, по умолчанию *buildAddress*.

Параметры плагина $('input').kladr
--------------------------------------------------------------------------------

* **token** - токен для доступа к сервису, по-умолчанию *null*.
* **key** - ключ для доступа к сервису, по-умолчанию *null*.
* **type** - тип подставляемых объектов, по-умолчанию *null*.
* **typeCode** - тип подставляемых населённых пунктов, по-умолчанию *null*.
* **token** - токен для доступа к сервису, по умолчанию *null*.
* **key** - ключ для доступа к сервису, по умолчанию *null*.
* **type** - тип подставляемых объектов, по умолчанию *null*.
* **typeCode** - тип подставляемых населённых пунктов, по умолчанию *null*.
Может быть использован только если *type == 'city'*.
* **parentType** - тип родительского объекта, по-умолчанию *null*.
* **parentId** - идентификатор родительского объекта, по-умолчанию *null*.
* **limit** - количество отображаемых в выпадающем списке объектов, по-умолчанию *10*.
* **oneString** - включить ввод адреса одной строкой, по-умолчанию *false*.
* **withParents** - получить объект вместе с родителями, по-умолчанию *false*.
* **parentType** - тип родительского объекта, по умолчанию *null*.
* **parentId** - идентификатор родительского объекта, по умолчанию *null*.
* **limit** - количество отображаемых в выпадающем списке объектов, по умолчанию *10*.
* **oneString** - включить ввод адреса одной строкой, по умолчанию *false*.
* **withParents** - получить объект вместе с родителями, по умолчанию *false*.
* **parentInput** - селектор, DOM элемент или же объект jQuery, в котором
находится поле ввода родительского объекта, по-умолчанию *null*.
* **verify** - проверять введённые данные, по-умолчанию *false*.
* **spinner** - отображать ajax-крутилку, по-умолчанию *true*.
находится поле ввода родительского объекта, по умолчанию *null*.
* **verify** - проверять введённые данные, по умолчанию *false*.
* **spinner** - отображать ajax-крутилку, по умолчанию *true*.
* **current** - текущий, выбранный объект КЛАДР, *только для чтения*.

Методы плагина $('input').kladr
--------------------------------------------------------------------------------

* **source** *= function( query ) { return objects; }* - функция для получения
списка объектов отображаемых при автодополнении. В качестве параметра принимает
объекта запроса. По-умолчанию запрашивает данные у сервиса [kladr-api.ru] [1].
объекта запроса. По умолчанию запрашивает данные у сервиса [kladr-api.ru] [1].
Может быть переопределена для получения объектов из другого источника.
* **labelFormat** *= function( obj, query) { return label; }* - функция для
форматирования значений в списке. В качестве параметров принимает *obj* – объект
Expand Down Expand Up @@ -122,8 +122,8 @@ jQuery Kladr
подставляет объекты этого адреса в другие поля формы (см. пример формы для ввода адреса
в папке [examples] [3]).

В качетве параметра принимает селектор, DOM элемент или же объект jQuery, в котором
будет выполнен поиск соответствующих полей адреса, по-умолчанию *body*.
В качестве параметра принимает селектор, DOM элемент или же объект jQuery, в котором
будет выполнен поиск соответствующих полей адреса, по умолчанию *body*.

Структура папок, файлов
--------------------------------------------------------------------------------
Expand Down Expand Up @@ -154,7 +154,7 @@ $('input').kladr({
});
`````

Изменении подписи при выборе района:
Изменение подписи при выборе района:

`````javascript
$('input').kladr({
Expand All @@ -171,7 +171,7 @@ $('input').kladr({
$('input').kladrZip('form');
`````

Более подробрые примеры можно найти в папке [examples] [3].
Более подробные примеры можно найти в папке [examples] [3].


Загрузка
Expand Down

0 comments on commit b201855

Please sign in to comment.