home1022
This commit is contained in:
bwstudio
+201
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2020 A11yance
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
+404
@@ -0,0 +1,404 @@
|
||||
# AXObject Query
|
||||
|
||||
|
||||
|
||||
Approximate model of the [Chrome AXObject](https://cs.chromium.org/chromium/src/third_party/WebKit/Source/modules/accessibility/AXObject.h).
|
||||
|
||||
The project attempts to map the AXObject concepts to the [WAI-ARIA 1.1 Roles Model](https://www.w3.org/TR/wai-aria-1.1/#roles) so that a complete representation of the semantic HTML layer, as it is exposed assistive technology, can be obtained.
|
||||
|
||||
CDN URL: <https://unpkg.com/axobject-query>
|
||||
|
||||
## Utilities
|
||||
|
||||
### AXObjects
|
||||
|
||||
```javascript
|
||||
import { AXObjects } from 'axobject-query';
|
||||
```
|
||||
|
||||
#### Interface
|
||||
|
||||
These methods are available on each export from the module. The typing here in the documentation is pseudo-typed. Each export will have its own specific types for each method signature.
|
||||
|
||||
```javascript
|
||||
{|
|
||||
entries: () => Array<$Item>,
|
||||
get: (key: $Key) => ?$Value,
|
||||
has: (key: $Key) => boolean,
|
||||
keys: () => Array<$Key>,
|
||||
values: () => Array<$Value>,
|
||||
|};
|
||||
```
|
||||
|
||||
### Concepts in the project
|
||||
|
||||
AXObjects are mapped to their HTML and ARIA concepts in the `relatedConcepts` field.
|
||||
|
||||
The `type` field is a loose association of an AXObject to the `window`, `structure` and `widget` abstract roles in ARIA. The `generic` value is given to `DivRole`; it does not exist in ARIA. Divs are special in HTML in the way that they are used as generic containers. Span might have also been associated with a generic type except that there is no `SpanRole` AXObject.
|
||||
|
||||
```javascript
|
||||
[
|
||||
[ 'AbbrRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'AlertDialogRole', { relatedConcepts: [ [Object] ], type: 'window' } ],
|
||||
[ 'AlertRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'AnnotationRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ApplicationRole', { relatedConcepts: [ [Object] ], type: 'window' } ],
|
||||
[ 'ArticleRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'AudioRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'BannerRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'BlockquoteRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'BusyIndicatorRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'ButtonRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'CanvasRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'CaptionRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'CellRole', { relatedConcepts: [ [Object], [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'CheckBoxRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'ColorWellRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'ColumnHeaderRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'ColumnRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ComboBoxRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'ComplementaryRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'ContentInfoRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DateRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'DateTimeRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'DefinitionRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DescriptionListDetailRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DescriptionListRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DescriptionListTermRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DetailsRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'DialogRole', { relatedConcepts: [ [Object], [Object] ], type: 'window' } ],
|
||||
[ 'DirectoryRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'DisclosureTriangleRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'DivRole', { relatedConcepts: [ [Object] ], type: 'generic' } ],
|
||||
[ 'DocumentRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'EmbeddedObjectRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'FeedRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'FigcaptionRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'FigureRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'FooterRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'FormRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'GridRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'GroupRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'HeadingRole', { relatedConcepts: [ [Object], [Object], [Object], [Object], [Object], [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'IframePresentationalRole', { relatedConcepts: [], type: 'window' } ],
|
||||
[ 'IframeRole', { relatedConcepts: [ [Object] ], type: 'window' } ],
|
||||
[ 'IgnoredRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ImageMapLinkRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'ImageMapRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'ImageRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'InlineTextBoxRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'InputTimeRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'LabelRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'LegendRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'LineBreakRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'LinkRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'ListBoxOptionRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'ListBoxRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'ListItemRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'ListMarkerRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ListRole', { relatedConcepts: [ [Object], [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'LogRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'MainRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'MarkRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'MarqueeRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'MathRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'MenuBarRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'MenuButtonRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'MenuItemRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'MenuItemCheckBoxRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'MenuItemRadioRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'MenuListOptionRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'MenuListPopupRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'MenuRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'MeterRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'NavigationRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'NoneRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'NoteRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'OutlineRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ParagraphRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'PopUpButtonRole', { relatedConcepts: [], type: 'widget' } ],
|
||||
[ 'PreRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'PresentationalRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'ProgressIndicatorRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'RadioButtonRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'RadioGroupRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'RegionRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'RootWebAreaRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'RowHeaderRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'RowRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'RubyRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'RulerRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ScrollAreaRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'ScrollBarRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'SeamlessWebAreaRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'SearchRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'SearchBoxRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'SliderRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'SliderThumbRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'SpinButtonRole', { relatedConcepts: [ [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'SpinButtonPartRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'SplitterRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'StaticTextRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'StatusRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'SVGRootRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'SwitchRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'TabGroupRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TabRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'TableHeaderContainerRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'TableRole', { relatedConcepts: [ [Object], [Object] ], type: 'structure' } ],
|
||||
[ 'TabListRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TabPanelRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TermRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TextFieldRole', { relatedConcepts: [ [Object], [Object], [Object] ], type: 'widget' } ],
|
||||
[ 'TimeRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TimerRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'ToggleButtonRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'ToolbarRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'TreeRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'TreeGridRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'TreeItemRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'UserInterfaceTooltipRole', { relatedConcepts: [ [Object] ], type: 'structure' } ],
|
||||
[ 'VideoRole', { relatedConcepts: [ [Object] ], type: 'widget' } ],
|
||||
[ 'WebAreaRole', { relatedConcepts: [], type: 'structure' } ],
|
||||
[ 'WindowRole', { relatedConcepts: [], type: 'window' } ],
|
||||
]
|
||||
```
|
||||
|
||||
### AXObject to Element
|
||||
|
||||
```javascript
|
||||
import { AXObjectElements } from 'axobject-query';
|
||||
```
|
||||
|
||||
AXObjects are mapped to their related HTML concepts, which may require attributes (in the case of inputs) to obtain the correct association.
|
||||
|
||||
```javascript
|
||||
[
|
||||
[ 'AbbrRole', [ { name: 'abbr' } ] ],
|
||||
[ 'ArticleRole', [ { name: 'article' } ] ],
|
||||
[ 'AudioRole', [ { name: 'audio' } ] ],
|
||||
[ 'BlockquoteRole', [ { name: 'blockquote' } ] ],
|
||||
[ 'ButtonRole', [ { name: 'button' } ] ],
|
||||
[ 'CanvasRole', [ { name: 'canvas' } ] ],
|
||||
[ 'CaptionRole', [ { name: 'caption' } ] ],
|
||||
[ 'CellRole', [ { name: 'td' } ] ],
|
||||
[ 'CheckBoxRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'ColorWellRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'ColumnHeaderRole', [ { name: 'th' } ] ],
|
||||
[ 'DateRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'DateTimeRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'DefinitionRole', [ { name: 'dfn' } ] ],
|
||||
[ 'DescriptionListDetailRole', [ { name: 'dd' } ] ],
|
||||
[ 'DescriptionListRole', [ { name: 'dl' } ] ],
|
||||
[ 'DescriptionListTermRole', [ { name: 'dt' } ] ],
|
||||
[ 'DetailsRole', [ { name: 'details' } ] ],
|
||||
[ 'DialogRole', [ { name: 'dialog' } ] ],
|
||||
[ 'DirectoryRole', [ { name: 'dir' } ] ],
|
||||
[ 'DivRole', [ { name: 'div' } ] ],
|
||||
[ 'EmbeddedObjectRole', [ { name: 'embed' } ] ],
|
||||
[ 'FigcaptionRole', [ { name: 'figcaption' } ] ],
|
||||
[ 'FigureRole', [ { name: 'figure' } ] ],
|
||||
[ 'FooterRole', [ { name: 'footer' } ] ],
|
||||
[ 'FormRole', [ { name: 'form' } ] ],
|
||||
[ 'HeadingRole', [ { name: 'h1' }, { name: 'h2' }, { name: 'h3' }, { name: 'h4' }, { name: 'h5' }, { name: 'h6' } ] ],
|
||||
[ 'IframeRole', [ { name: 'iframe' } ] ],
|
||||
[ 'ImageMapRole', [ { name: 'img', attributes: [Object] } ] ],
|
||||
[ 'ImageRole', [ { name: 'img' } ] ],
|
||||
[ 'InlineTextBoxRole', [ { name: 'input' } ] ],
|
||||
[ 'InputTimeRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'LabelRole', [ { name: 'label' } ] ],
|
||||
[ 'LegendRole', [ { name: 'legend' } ] ],
|
||||
[ 'LineBreakRole', [ { name: 'br' } ] ],
|
||||
[ 'LinkRole', [ { name: 'a', attributes: [Object] } ] ],
|
||||
[ 'ListBoxOptionRole', [ { name: 'option' } ] ],
|
||||
[ 'ListItemRole', [ { name: 'li' } ] ],
|
||||
[ 'ListRole', [ { name: 'ul' }, { name: 'ol' } ] ],
|
||||
[ 'MainRole', [ { name: 'main' } ] ],
|
||||
[ 'MarkRole', [ { name: 'mark' } ] ],
|
||||
[ 'MarqueeRole', [ { name: 'marquee' } ] ],
|
||||
[ 'MenuItemRole', [ { name: 'menuitem' } ] ],
|
||||
[ 'MenuRole', [ { name: 'menu' } ] ],
|
||||
[ 'MeterRole', [ { name: 'meter' } ] ],
|
||||
[ 'NavigationRole', [ { name: 'nav' } ] ],
|
||||
[ 'ParagraphRole', [ { name: 'p' } ] ],
|
||||
[ 'PreRole', [ { name: 'pre' } ] ],
|
||||
[ 'ProgressIndicatorRole', [ { name: 'progress' } ] ],
|
||||
[ 'RadioButtonRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'RowHeaderRole', [ { name: 'th', attributes: [Object] } ] ],
|
||||
[ 'RowRole', [ { name: 'tr' } ] ],
|
||||
[ 'RubyRole', [ { name: 'ruby' } ] ],
|
||||
[ 'SearchBoxRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'SliderRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'SpinButtonRole', [ { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'TableRole', [ { name: 'table' } ] ],
|
||||
[ 'TextFieldRole', [ { name: 'input' }, { name: 'input', attributes: [Object] } ] ],
|
||||
[ 'TimeRole', [ { name: 'time' } ] ],
|
||||
[ 'VideoRole', [ { name: 'video' ] ],
|
||||
]
|
||||
```
|
||||
|
||||
### AXObject to Role
|
||||
|
||||
```javascript
|
||||
import { AXObjectRoles } from 'axobject-query';
|
||||
```
|
||||
|
||||
AXObjects are mapped to their related ARIA concepts..
|
||||
|
||||
```javascript
|
||||
[
|
||||
[ 'AlertDialogRole', [ { name: 'alertdialog' } ] ],
|
||||
[ 'AlertRole', [ { name: 'alert' } ] ],
|
||||
[ 'ApplicationRole', [ { name: 'application' } ] ],
|
||||
[ 'ArticleRole', [ { name: 'article' } ] ],
|
||||
[ 'BannerRole', [ { name: 'banner' } ] ],
|
||||
[ 'BusyIndicatorRole', [ { attributes: [Object] } ] ],
|
||||
[ 'ButtonRole', [ { name: 'button' } ] ],
|
||||
[ 'CellRole', [ { name: 'cell' }, { name: 'gridcell' } ] ],
|
||||
[ 'CheckBoxRole', [ { name: 'checkbox' } ] ],
|
||||
[ 'ColumnHeaderRole', [ { name: 'columnheader' } ] ],
|
||||
[ 'ComboBoxRole', [ { name: 'combobox' } ] ],
|
||||
[ 'ComplementaryRole', [ { name: 'complementary' } ] ],
|
||||
[ 'ContentInfoRole', [ { name: 'structureinfo' } ] ],
|
||||
[ 'DialogRole', [ { name: 'dialog' } ] ],
|
||||
[ 'DirectoryRole', [ { name: 'directory' } ] ],
|
||||
[ 'DocumentRole', [ { name: 'document' } ] ],
|
||||
[ 'FeedRole', [ { name: 'feed' } ] ],
|
||||
[ 'FigureRole', [ { name: 'figure' } ] ],
|
||||
[ 'FormRole', [ { name: 'form' } ] ],
|
||||
[ 'GridRole', [ { name: 'grid' } ] ],
|
||||
[ 'GroupRole', [ { name: 'group' } ] ],
|
||||
[ 'HeadingRole', [ { name: 'heading' } ] ],
|
||||
[ 'ImageRole', [ { name: 'img' } ] ],
|
||||
[ 'LinkRole', [ { name: 'link' } ] ],
|
||||
[ 'ListBoxOptionRole', [ { name: 'option' } ] ],
|
||||
[ 'ListBoxRole', [ { name: 'listbox' } ] ],
|
||||
[ 'ListItemRole', [ { name: 'listitem' } ] ],
|
||||
[ 'ListRole', [ { name: 'list' } ] ],
|
||||
[ 'LogRole', [ { name: 'log' } ] ],
|
||||
[ 'MainRole', [ { name: 'main' } ] ],
|
||||
[ 'MarqueeRole', [ { name: 'marquee' } ] ],
|
||||
[ 'MathRole', [ { name: 'math' } ] ],
|
||||
[ 'MenuBarRole', [ { name: 'menubar' } ] ],
|
||||
[ 'MenuItemRole', [ { name: 'menuitem' } ] ],
|
||||
[ 'MenuItemCheckBoxRole', [ { name: 'menuitemcheckbox' } ] ],
|
||||
[ 'MenuItemRadioRole', [ { name: 'menuitemradio' } ] ],
|
||||
[ 'MenuRole', [ { name: 'menu' } ] ],
|
||||
[ 'NavigationRole', [ { name: 'navigation' } ] ],
|
||||
[ 'NoneRole', [ { name: 'none' } ] ],
|
||||
[ 'NoteRole', [ { name: 'note' } ] ],
|
||||
[ 'PresentationalRole', [ { name: 'presentation' } ] ],
|
||||
[ 'ProgressIndicatorRole', [ { name: 'progressbar' } ] ],
|
||||
[ 'RadioButtonRole', [ { name: 'radio' } ] ],
|
||||
[ 'RadioGroupRole', [ { name: 'radiogroup' } ] ],
|
||||
[ 'RegionRole', [ { name: 'region' } ] ],
|
||||
[ 'RowHeaderRole', [ { name: 'rowheader' } ] ],
|
||||
[ 'RowRole', [ { name: 'row' } ] ],
|
||||
[ 'ScrollBarRole', [ { name: 'scrollbar' } ] ],
|
||||
[ 'SearchRole', [ { name: 'search' } ] ],
|
||||
[ 'SearchBoxRole', [ { name: 'searchbox' } ] ],
|
||||
[ 'SliderRole', [ { name: 'slider' } ] ],
|
||||
[ 'SpinButtonRole', [ { name: 'spinbutton' } ] ],
|
||||
[ 'SplitterRole', [ { name: 'separator' } ] ],
|
||||
[ 'StatusRole', [ { name: 'status' } ] ],
|
||||
[ 'SwitchRole', [ { name: 'switch' } ] ],
|
||||
[ 'TabGroupRole', [ { name: 'tablist' } ] ],
|
||||
[ 'TabRole', [ { name: 'tab' } ] ],
|
||||
[ 'TableRole', [ { name: 'table' } ] ],
|
||||
[ 'TabListRole', [ { name: 'tablist' } ] ],
|
||||
[ 'TabPanelRole', [ { name: 'tabpanel' } ] ],
|
||||
[ 'TermRole', [ { name: 'term' } ] ],
|
||||
[ 'TextFieldRole', [ { name: 'textbox' } ] ],
|
||||
[ 'TimerRole', [ { name: 'timer' } ] ],
|
||||
[ 'ToggleButtonRole', [ { attributes: [Object] } ] ],
|
||||
[ 'ToolbarRole', [ { name: 'toolbar' } ] ],
|
||||
[ 'TreeRole', [ { name: 'tree' } ] ],
|
||||
[ 'TreeGridRole', [ { name: 'treegrid' } ] ],
|
||||
[ 'TreeItemRole', [ { name: 'treeitem' } ] ],
|
||||
[ 'UserInterfaceTooltipRole', [ { name: 'tooltip' } ] ],
|
||||
]
|
||||
```
|
||||
|
||||
### Element to AXObject
|
||||
|
||||
```javascript
|
||||
import { elementAXObjects } from 'axobject-query';
|
||||
```
|
||||
|
||||
HTML elements are mapped to their related AXConcepts concepts.
|
||||
|
||||
```javascript
|
||||
[
|
||||
[ { name: 'abbr' }, [ 'AbbrRole' ] ],
|
||||
[ { name: 'article' }, [ 'ArticleRole' ] ],
|
||||
[ { name: 'audio' }, [ 'AudioRole' ] ],
|
||||
[ { name: 'blockquote' }, [ 'BlockquoteRole' ] ],
|
||||
[ { name: 'button' }, [ 'ButtonRole' ] ],
|
||||
[ { name: 'canvas' }, [ 'CanvasRole' ] ],
|
||||
[ { name: 'caption' }, [ 'CaptionRole' ] ],
|
||||
[ { name: 'td' }, [ 'CellRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'CheckBoxRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'ColorWellRole' ] ],
|
||||
[ { name: 'th' }, [ 'ColumnHeaderRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'DateRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'DateTimeRole' ] ],
|
||||
[ { name: 'dfn' }, [ 'DefinitionRole' ] ],
|
||||
[ { name: 'dd' }, [ 'DescriptionListDetailRole' ] ],
|
||||
[ { name: 'dl' }, [ 'DescriptionListRole' ] ],
|
||||
[ { name: 'dt' }, [ 'DescriptionListTermRole' ] ],
|
||||
[ { name: 'details' }, [ 'DetailsRole' ] ],
|
||||
[ { name: 'dialog' }, [ 'DialogRole' ] ],
|
||||
[ { name: 'dir' }, [ 'DirectoryRole' ] ],
|
||||
[ { name: 'div' }, [ 'DivRole' ] ],
|
||||
[ { name: 'embed' }, [ 'EmbeddedObjectRole' ] ],
|
||||
[ { name: 'figcaption' }, [ 'FigcaptionRole' ] ],
|
||||
[ { name: 'figure' }, [ 'FigureRole' ] ],
|
||||
[ { name: 'footer' }, [ 'FooterRole' ] ],
|
||||
[ { name: 'form' }, [ 'FormRole' ] ],
|
||||
[ { name: 'h1' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'h2' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'h3' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'h4' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'h5' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'h6' }, [ 'HeadingRole' ] ],
|
||||
[ { name: 'iframe' }, [ 'IframeRole' ] ],
|
||||
[ { name: 'img', attributes: [ [Object] ] }, [ 'ImageMapRole' ] ],
|
||||
[ { name: 'img' }, [ 'ImageRole' ] ],
|
||||
[ { name: 'input' }, [ 'InlineTextBoxRole', 'TextFieldRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'InputTimeRole' ] ],
|
||||
[ { name: 'label' }, [ 'LabelRole' ] ],
|
||||
[ { name: 'legend' }, [ 'LegendRole' ] ],
|
||||
[ { name: 'br' }, [ 'LineBreakRole' ] ],
|
||||
[ { name: 'a', attributes: [ [Object] ] }, [ 'LinkRole' ] ],
|
||||
[ { name: 'option' }, [ 'ListBoxOptionRole' ] ],
|
||||
[ { name: 'li' }, [ 'ListItemRole' ] ],
|
||||
[ { name: 'ul' }, [ 'ListRole' ] ],
|
||||
[ { name: 'ol' }, [ 'ListRole' ] ],
|
||||
[ { name: 'main' }, [ 'MainRole' ] ],
|
||||
[ { name: 'mark' }, [ 'MarkRole' ] ],
|
||||
[ { name: 'marquee' }, [ 'MarqueeRole' ] ],
|
||||
[ { name: 'menuitem' }, [ 'MenuItemRole' ] ],
|
||||
[ { name: 'menu' }, [ 'MenuRole' ] ],
|
||||
[ { name: 'meter' }, [ 'MeterRole' ] ],
|
||||
[ { name: 'nav' }, [ 'NavigationRole' ] ],
|
||||
[ { name: 'p' }, [ 'ParagraphRole' ] ],
|
||||
[ { name: 'pre' }, [ 'PreRole' ] ],
|
||||
[ { name: 'progress' }, [ 'ProgressIndicatorRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'RadioButtonRole' ] ],
|
||||
[ { name: 'th', attributes: [ [Object] ] }, [ 'RowHeaderRole' ] ],
|
||||
[ { name: 'tr' }, [ 'RowRole' ] ],
|
||||
[ { name: 'ruby' }, [ 'RubyRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'SearchBoxRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'SliderRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'SpinButtonRole' ] ],
|
||||
[ { name: 'table' }, [ 'TableRole' ] ],
|
||||
[ { name: 'input' }, [ 'InlineTextBoxRole', 'TextFieldRole' ] ],
|
||||
[ { name: 'input', attributes: [ [Object] ] }, [ 'TextFieldRole' ] ],
|
||||
[ { name: 'time' }, [ 'TimeRole' ] ],
|
||||
[ { name: 'video' }, [ 'VideoRole' ] ],
|
||||
]
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2021 A11yance
|
||||
+69
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"name": "axobject-query",
|
||||
"version": "4.1.0",
|
||||
"description": "Programmatic access to information about the AXObject Model",
|
||||
"main": "lib/index.js",
|
||||
"files": [
|
||||
"lib"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "rimraf lib && babel src --out-dir lib",
|
||||
"flow": "flow",
|
||||
"lint": "eslint --ext=js,mjs .",
|
||||
"lint:fix": "npm run lint -- --fix",
|
||||
"prepublishOnly": "npm run build",
|
||||
"pretest": "npm run lint:fix && npm run flow",
|
||||
"test": "npm run tests-only",
|
||||
"build:tests": "npm run build && rimraf __tests-built__ && BABEL_ENV=test babel __tests__ --out-dir __tests-built__",
|
||||
"tests-built": "nyc tape '__tests-built__/**/*.js'",
|
||||
"tests-only": "nyc tape -r @babel/register '__tests__/**/*.js'",
|
||||
"prepack": "npm run build"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/A11yance/axobject-query.git"
|
||||
},
|
||||
"keywords": [
|
||||
"accessibility"
|
||||
],
|
||||
"author": "Jesse Beach <splendidnoise@gmail.com>",
|
||||
"license": "Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/A11yance/axobject-query/issues"
|
||||
},
|
||||
"homepage": "https://github.com/A11yance/axobject-query#readme",
|
||||
"devDependencies": {
|
||||
"@babel/cli": "^7.19.3",
|
||||
"@babel/core": "^7.19.6",
|
||||
"@babel/eslint-parser": "^7.19.1",
|
||||
"@babel/plugin-transform-react-jsx": "^7.24.7",
|
||||
"@babel/preset-env": "^7.19.4",
|
||||
"@babel/preset-flow": "^7.18.6",
|
||||
"@babel/register": "^7.24.6",
|
||||
"babel-plugin-module-resolver": "^5.0.2",
|
||||
"deep-equal-json": "^1.0.0",
|
||||
"encoding": "^0.1.13",
|
||||
"eslint": "^8.26.0",
|
||||
"eslint-config-airbnb-base": "^15.0.0",
|
||||
"eslint-plugin-flowtype": "^8.0.3",
|
||||
"eslint-plugin-import": "^2.26.0",
|
||||
"expect": "^29.2.1",
|
||||
"flow-bin": "^0.190.1",
|
||||
"flow-typed": "^3.8.0",
|
||||
"mock-property": "^1.0.3",
|
||||
"nyc": "^10.3.2",
|
||||
"object-inspect": "^1.13.2",
|
||||
"object.values": "^1.2.0",
|
||||
"rimraf": "^3.0.2",
|
||||
"tape": "^5.8.1"
|
||||
},
|
||||
"browserslist": [
|
||||
">0.2%",
|
||||
"not dead",
|
||||
"not op_mini all",
|
||||
"ie 11"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">= 0.4"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user