Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codex-team/codex.special
Module for making high-contrast version of websites. Simple usage.
https://github.com/codex-team/codex.special
a11y accessibility codex front-end high-contrast module wcag
Last synced: 3 months ago
JSON representation
Module for making high-contrast version of websites. Simple usage.
- Host: GitHub
- URL: https://github.com/codex-team/codex.special
- Owner: codex-team
- License: other
- Created: 2016-09-24T09:03:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-12T08:41:34.000Z (over 7 years ago)
- Last Synced: 2024-04-24T05:55:59.127Z (9 months ago)
- Topics: a11y, accessibility, codex, front-end, high-contrast, module, wcag
- Language: JavaScript
- Homepage: https://ifmo.su/special
- Size: 131 KB
- Stars: 10
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Модуль для активации контрастной версии сайта
CodeX.Special сделает информацию на вашем сайте более доступной для людей с ограниченными возможностями. Модуль прост в подключении и использовании.
## Установка
CodeX.Special поддерживает несколько возможных вариантов установки.
### Подключение с вашего сервера
Сохраните файлы модуля и подключите js-скрипт.
```html
```
### GitHub CDN
Вы также можете подключить скрипт с серверов GitHub, ничего не скачивая.
```html
```
### NPM
Установите [codex.special](https://www.npmjs.com/package/codex.special) с помощью менеджера пакетов для Node.js
```shell
npm i --save codex.special
```
Импортируйте пакет
```js
var codexSpecial = require('codex.special');
```
## Инициализация
Для того, чтобы запустить модуль, достаточно вызвать метод `init()`.
```js
codexSpecial.init({});
```
Чтобы скрипт запускался до того, как загрузится страница, добавьте инициализацию модуля в тег скрипта.
```html
```
Результат
## Дополнительные параметры
### Положение панели на странице
По умолчанию скрипт создает панель, которая привязана к верхней правой границе экрана.
Угол, в котором будет располагаться панель управления модулем, можно указать в параметре `position`.
Возможные значения: `top-left`, `bottom-right`, `bottom-left`, `top-right` (устанавливается по-умолчанию).
```js
codexSpecial.init({
position : 'bottom-right',
});
```
Вы можете определить положение панели, указав в параметре `blockId` идентификатор обертки.
Например, чтобы встроить панель в блок с идентификатором `#panelHolder`:
```js
codexSpecial.init({
blockId : 'panelHolder',
});
```
### Мультиязычность
При необходимости можно инициализировать скрипт с параметром `lang`, определяющим язык для надписей на блоке.
Доступны `ru` и `en` для русского и английского языка.
```js
codexSpecial.init({
lang : 'en',
});
```
## Разработка
Codex Team —
Страница проекта 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
Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, слияние, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, а также лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:
Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.
ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.