Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluecadet/bluecadet_accessibility
https://github.com/bluecadet/bluecadet_accessibility
a11y drupal drupal-module module
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bluecadet/bluecadet_accessibility
- Owner: bluecadet
- Created: 2023-11-02T17:11:33.000Z (about 1 year ago)
- Default Branch: 1.x
- Last Pushed: 2024-01-31T20:55:53.000Z (10 months ago)
- Last Synced: 2024-10-12T01:22:30.702Z (about 1 month ago)
- Topics: a11y, drupal, drupal-module, module
- Language: PHP
- Homepage:
- Size: 129 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CONTENTS OF THIS FILE
---------------------
* Introduction
* Installation
* Configuration
* FAQ
* Maintainers
* Changelog
INTRODUCTION
------------
This module handles custom functionality for bluecadet_accessibility.
Current Functionality:
* Add a option in Views when using AJAX for enhanced accessibility.
INSTALLATION
------------
* Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/node/1897420 for further information.
CONFIGURATION
-------------
Configuration can be found on a view under the Display formatter.
## Assumptions about our view templates:
- Maintain “views” class names, but can add pre-defined or custom class names.
- Assume basic top level template (views-view.html.twig) structure.
- Results should be in an unordered list (the list part is the important part) . Unordered lists help screen reader users navigate from the first item in a list to the end of the list or jump to the next list. It can also help them bypass groups of links if they choose to. ([W3C, H48: Using ol, ul and dl for lists or groups of links](https://www.w3.org/TR/WCAG20-TECHS/H48.html#:~:text=The%20list%20structure%20(%20ul%20%2F%20ol,links%20if%20they%20choose%20to.))
- There should be a title (can be screen reader only) `
Results
` default is before ul and a child of “view-content”
- Need a header, which is usually an h2, before filters and before results ideally `Filter Results
` and `Results
` is visually hidden.
- Buttons and pagers can set a `data-announce-text` attr which will be announced rather than a generic string.
## How to add custom announce text to templates (exposed forms, pager templates).
### Form elements
```php
Search
OR
Filter
```
### Pager elements
```php
...
{% for key, item in items.pages %}
Page
{{- key -}}
{% endfor %}
...
```
## Optional CSS for smooth scrolling
```CSS
html {
scroll-behavior: smooth;
}
```
MAINTAINERS
-----------
Current maintainers:
* Pete Inge (pingevt) - https://www.drupal.org/user/411339
* Amy Frear - https://www.frear-projects.com/
This project has been sponsored by:
* Bluecadet - https://www.bluecadet.com/
CHANGELOG
---------
# Unreleased
-
# 1.x
- Adds Drupal Views Display Extender for enhanced accessibility.
## Proudly developed @ Bluecadet
