https://github.com/jpdevries/a11y-datagrid

Accessible Data Grid
https://github.com/jpdevries/a11y-datagrid

a11y html5 jsx react redux

Last synced: 2 months ago
JSON representation

Accessible Data Grid

• Host: GitHub
• URL: https://github.com/jpdevries/a11y-datagrid
• Owner: jpdevries
• License: bsd-3-clause
• Created: 2017-05-27T13:50:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-01T07:57:37.000Z (over 7 years ago)
• Last Synced: 2024-11-22T01:42:01.232Z (3 months ago)
• Topics: a11y, html5, jsx, react, redux
• Language: CSS
• Size: 15.7 MB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Accessible DataGrid

WIP.

![](http://j4p.us/1d00151e3y1L/Screen%20Shot%202017-05-29%20at%2011.30.31%20AM.png)

## Demo

[Try the demo](http://a11y-datagrid.markup.tips/).

## Screencast

[Watch the 4min screencast](https://vimeo.com/219314498) on Vimeo.

## Goals

 - Accessible Data Grid

    - Keyboard

    - Screen Reader

      - ARIA

      - `.visually-hidden` text

    - Mobile

    - Vision

      - Low Vision

      - Contrast

        - White on Black

      - Reduced Motion

## ♿️ Accessibility Proclaimer

This project strives for WCAG Level AA success criteria in all scenarios with some accessibility preference features leaning towards Level AAA. Please [log *any* a11y issues here](https://github.com/jpdevries/a11y-datagrid/issues).

## REST API

WIP. Pending advisory from the MODX AdvisoryBoard.  

A robust rest API allows the data grid to be browsed by the URL all the way down to targeting specific rows, filter, and pagination settings.

### System Settings

| Route  | HTTP Verb | Description |

| ------------- | ------------- | ------------- |

| `settings/:namespace`  | `GET`  | Retrieve a list of settings in a given namespace

| `settings/:namespace?q=foo`  | `GET`  | Search for foo in a given namespace

| `settings/:namespace/:area`  | `GET`  | Retrieve a list of settings in a given area of a given namespace

| `settings/:namespace/:area/:xtype`  | `GET`  | Retrieve a list of settings of a certain xtype in a given area of a given namespace

| `settings/:namespace/?p2`  | `GET`  | Retrieve the second page of a list of settings in a given namespace

| `settings/:namespace/?s=editedon`  | `GET`  | Retrieve a list of settings in a given namespace sorted by editedon

| `settings/:namespace/?s=editedon&d=desc`  | `GET`  | Retrieve a list of settings in a given namespace sorted by editedon in descending order

| `settings/:namespace/?p2&pp=50`  | `GET`  | Showing 50 settings per page, Retrieve the second page of a list of settings in a given namespace

| `settings/:namespace/#site_status`  | `GET`  | Retrieve a list of settings in a given namespace, set target to `#site_status`

### Context Settings

Just like System Settings but `context/settings`.

### Resources

WIP. Support options like:

 - publishedon

 - hidden from menus

 - published

 - parent

| Route  | HTTP Verb | Description |

| ------------- | ------------- | ------------- |

| `resources/:context`  | `GET`  | Retrieve a list of resources in a given context

| `resources/:context/:parent`  | `GET`  | Retrieve a list of resources of a given parent in a given context

| `resources/:context/:parent/:template`  | `GET`  | Retrieve a list of resources of a given template of a given parent in a given context

| `resources/:context/:parent/:template`  | `POST`  | Create a new resource within a given parent of a given template in a given context

| `resources/:context/:parent/:template`  | `GET`  | Retrieve a list of resources of a given template within a given parent in a given context

### Users

WIP.

| Route  | HTTP Verb | Description |

| ------------- | ------------- | ------------- |

| `users/:usergroup`  | `GET`  | Retrieve a list of users in a given usergroup

| `users/:usergroup/:role`  | `GET`  | Retrieve a list of users of a given usergroup with a given role

| `users/:usergroup/:role/:status`  | `GET`  | Retrieve a list of users of a given usergroup with a given role and a given status

## ⌨️ Keyboard Shortcuts

Eureka uses JavaScript events to enrich the user experience of keyboard users.

| Shortcut        | Command              |

| --------------- |:-------------:       |

| Sort Ascending | alt+up                  |

| Sort Descending | alt+down                  |