ПОДКЛЮЧЕНИЕ

1. Сохраните файл _[qr-code.js](https://raw.githubusercontent.com/alekstar79/qr-code/main/dist/js/qr-code.js)_ По ссылке страница перенаправляется на содержимое файла.
Нажмите правую кнопку мыши ( или сочетание клавиш `Ctrl`+`S` / `CMD`+`S` ) и выберите `Сохранить как`
2. В html файле, в теге `` вставьте тег `

``` ### Пример подключения с вызовом из js-файла ```html

``` __main.js__ ```js const qrcode1 = makeQRCode('Привет, Мир!', { mode: 4, eccl: 0, version: 3, mask: -1, image: 'html', modsize: -1, margin: 0 }) const qrcode2 = makeQRCode('Привет, Мир!', { mode: 1}) const content = qrcode => qrcode.error ? `недопустимые исходные данные ${qrcode.error}` : qrcode.result document.getElementById('qrcode1').append('QR-код № 1: ', content(qrcode1)) document.getElementById('qrcode2').append('QR-код № 2: ', content(qrcode2)) ```

СИНТАКСИС

window.makeQRCode(text [, options ]) или makeQRCode(text [, options ]) ### Параметры __text__
Кодируемая текстовая строка UTF-8. __options__
Объект, содержащий свойства со значениями параметров генерации QR-кода, по умолчанию:
`{mode: -1, eccl: 0, version: -1, mask: -1, image: 'PNG', modsize: -1, margin: -1}` ### Возвращаемое значение Объект __`qrcode`__, описывающий результат генерации QR-кода.

ОПИСАНИЕ

### 1. Свойство `options` #### 1.1. Основные свойства `options`, содержащие значения параметров формирования матрицы QR-кода | свойство | значение | содержание | |:-----------:|:----------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------| | __mode__ | целое число
__-1, 1, 2, 4__ | __метод кодирования__
1 - числовой,
2 - буквенно-цифровой,
4 - октетный,
если не указан или -1,
то выбирается допустимый | | __eccl__ | целое число
__от -1 до 3__ | __уровень коррекции ошибок__
1(__L__), 0(__M__), 3(__Q__), 2(__H__)
если не указан или -1,
то подбор допустимого, начиная с 3(Q) | | __version__ | целое число
__-1__
или
__от 1 до 40__ | __версия__
если не указана или -1, то выбирается наименьшая возможная | | __mask__ | целое число
__-1__
или
__от 0 до 7__ | __шаблон маски__
если не указан или -1, то выбирается лучшая маска | #### 1.2. Дополнительные свойства `options`, содержащие значения параметров формирования изображения | свойство | значение | содержание | |:-----------:|:-----------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------| | __image__ | регистронезависимая строка
__'PNG'__, __'SVG'__, __'HTML'__
или
__'NONE'__ | __формат изображения__,
если не указан, то результат выводится в формате 'PNG',
при задании значения 'NONE' - результат не формируется | | __modsize__ | целое число
__-1__
или
__от 1__ | __размер модуля
`modsize x modsize`__
если не указан или -1, то 4 | | __margin__ | целое число
__от 0__ | __размер свободной зоны в модулях__,
если не указан, то 4 модуля | ### 2. Возвращаемый объект `qrcode` #### 2.1. Свойства `qrcode` | свойство | значение | содержание | |:----------------------------------------------:|:-----------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------| | __text__ | заданное | __исходный текст__ | | __mode__
__eccl____version__
__mask__ | заданное
или
подобранное | __параметры сформированной матрицы QR-кода__ | | __modsize__
__margin__ | заданно
или
по умолчанию | __параметры сформированной матрицы QR-кода__
и __параметры изображения QR-кода__ | | __image__ | заданное | __формат изображения QR-кода__
или
__'NONE'__ | | __matrix__ | __массив [`у`][`х`]__
__`у`__`-индекс колонки,`
__`х`__`-индекс строки` | __матрица QR-кода__
где значение элемента матрицы соответствует цвету изображения модуля:
0 - белый,
1 - черный | | __result__ | __HTML элемент__
или
__''__ | __изображение QR-кода в заданом формате__
или
__пустая строка__ в случае ошибки, или когда был задан параметр `image === 'NONE'` | | __error__ | __имя свойства__
или
__''__ | __имя свойства, значение которого вызвало ошибку__
или
__пустая строка__ при отстутствии ошибок | | __errorSubcode__ | строка
с целочисленным
цифроовым __кодом__
или
__''__ | __код, поясняющий ошибку__
или
__пустая строка__ при отстутствии ошибок |
#### 2.2. Методы `qrcode` __
`qrcode.`image = newImage
__ __`newImage`__
новое значение формата изображения
При изменении текущего формата `qrcode.image` на новое значение `newImage` происходит переформирование изображения. >Процесс может вызвать ошибку:
`qrcode.error === "image"`.
__
`qrcode.`download (`filename`, `image`)
__ Вызывает скачивание изображения QR-кода в виде файла с именем `filename` в формате `image`. __`filename`__
Имя файла для скачивания изображения, включая расширение. >Если параметр `filename` не задан или `filename === ''`, то `filename` примает значение по умолчанию:
-`'qrcode.png'` при `qrcode.image === 'PNG'`
-`'qrcode.svg'` при `qrcode.image === 'SVG'`
-`'qrcode.html'` при `qrcode.image === 'HTML'` __`image`__
Формат файла изображения QR-кода. >Если параметр `image` не задан, то приниматся текущее значение `qrcode.image`. >Если параметр `image` указан, то до вывода изображение переформируется ( соответствует методу `qrcode.image = newImage`). >Если при переформировании изображения произошла ошибка `qrcode.error !== ""` или задан формат `qrcode.image === 'NONE'` и, соответственно, отсутствует результат `qrcode.result === ''`, то запрос на скачиваение файла не выполняется.
__
`qrcode`.clearError()
__ Очистка сообщения об ошибке `qrcode.error` и `qrcode.errorSubcode`. >При наличии ошибок формирования изображения, методы: `qrcode.image = newImage` и `qrcode.download(filename, image)` не работают, пока сообщение не будет обработано и (или) очищено `qrcode.clearError()`
#### 2.3. Типы и подкоды ошибок | error | errorSubcode | содержание | |:-----------:|:------------:|:------------------------------------------------------| | __text__ | __1__ | недопустимый формат строки для кодирования | | __text__ | __2__ | не указан текст для кодирования | | __text__ | __3__ | текст содержит недопустимые символы | | __mode__ | __1__ | недопустимый или неподдерживаемый метод кодирования | | __version__ | __1__ | слишком длинный текст для кодирования | | __version__ | __2__ | недопустимая версия | | __version__ | __3__ | текст слишком длинный для выбранной версии | | __eccl__ | __1__ | недопустимый уровень коррекции ошибок | | __mask__ | __1__ | недопустимый шаблон маски | | __image__ | __1__ | недопустимый формат изображения для генерации QR-кода | | __image__ | __2__ | для вывода в формате PNG необходима поддержка canvas | | __image__ | __3__ | недопустимый формат изображения для генерации QR-кода | | __modsize__ | __1__ | недопустимый размер модуля | | __margin__ | __1__ | недопустимый размер свободной зоны (в модулях) |
СОВМЕСТИМОСТЬ С БРАУЗЕРАМИ
Chrome v.106, Firefox v.105, Яндекс.Браузер v.22, Brave v.1.44, Microsoft Edge v.106
ПОЛЕЗНЫЕ ССЫЛКИ
__Прототип [qrcode.js](https://github.com/shesek/qruri/blob/master/index.js)__ __Учебник__ [QR Code Tutorial](https://www.thonky.com/qr-code-tutorial/introduction) __Habr.com__ [Алгоритм генерации QR-кода](https://habr.com/ru/post/172525/) __Стандарт__ [Спецификация символики штрихового кода QR Code ISO/IEC 18004:2015](https://meganorm.ru/Data2/1/4293763/4293763455.pdf)