node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »

codex.special

Модуль для активации контрастной версии сайта

CodeX.Special сделает информацию на вашем сайте более доступной для людей с ограниченными возможностями. Модуль прост в подключении и использовании.

Установка

CodeX.Special поддерживает несколько возможных вариантов установки.

Подключение с вашего сервера

Сохраните файлы модуля и подключите js-скрипт.

<script src="/public/extensions/codex.special/codex-special.min.js"></script>

GitHub CDN

Вы также можете подключить скрипт с серверов GitHub, ничего не скачивая.

<script src="https://cdn.rawgit.com/codex-team/codex.special/master/codex-special.min.js"></script>

NPM

Установите codex.special с помощью менеджера пакетов для Node.js

npm i --save codex.special

Импортируйте пакет

var codexSpecial = require('codex.special');

Инициализация

Для того, чтобы запустить модуль, достаточно вызвать метод init().

codexSpecial.init({});

Чтобы скрипт запускался до того, как загрузится страница, добавьте инициализацию модуля в тег скрипта.

<script ... onload="codexSpecial.init({});"></script>

Результат

screen shot 2016-10-20 at 02 38 43

Дополнительные параметры

Положение панели на странице

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

Угол, в котором будет располагаться панель управления модулем, можно указать в параметре position.

Возможные значения: top-left, bottom-right, bottom-left, top-right (устанавливается по-умолчанию).

codexSpecial.init({
    position : 'bottom-right',
});

Вы можете определить положение панели, указав в параметре blockId идентификатор обертки.

Например, чтобы встроить панель в блок с идентификатором #panelHolder:

codexSpecial.init({
    blockId : 'panelHolder',
});
screen shot 2016-12-13 at 18 51 13

Мультиязычность

При необходимости можно инициализировать скрипт с параметром lang, определяющим язык для надписей на блоке. Доступны ru и en для русского и английского языка.

codexSpecial.init({
   lang : 'en',
});
screen shot 2016-10-20 at 02 56 17

Разработка

Codex Team — team@ifmo.su

Страница проекта CodeX.Special — https://ifmo.su/special

GitHub — https://github.com/codex-team/codex.special

NPM — https://www.npmjs.com/package/codex.special

Лицензия

Copyright (c) 2017 CodeX

Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, слияние, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, а также лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:

Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.

ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.