You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: build/metalsmith/index.html
+1-1
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ <h1 id="what-is-focusable">What is focusable?</h1>
65
65
</header>
66
66
67
67
<section>
68
-
<p>Do you know which elements are <em>focusable</em> or <em>tabbable</em>? ally.js does and does it's best to hide that complexity behind <ahref="api/index.html#Finding-elements">simple to use APIs</a>.</p>
68
+
<p>Do you know which elements are <em>focusable</em> or <em>tabbable</em>? ally.js does and does it's best to hide that complexity behind <ahref="api/index.html#finding-elements">simple to use APIs</a>.</p>
69
69
<p><ahref="data-tables/focusable.html"><imgsrc="assets/home/focusable-crop.png" alt="image of focusable data-table"></a></p>
70
70
<p>See <ahref="what-is-focusable.html">What does "focusable" mean</a>.</p>
Copy file name to clipboardExpand all lines: docs/api/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -41,12 +41,12 @@ In order to work with focusable elements, we must first know which elements we'r
41
41
*[`ally.query.focusable`](query/focusable.md) finds all focusable elements
42
42
*[`ally.query.shadowHosts`](query/shadow-hosts.md) finds all elements hosting a `ShadowRoot`
43
43
*[`ally.query.tabbable`](query/tabbable.md) finds all keyboard focusable elements in DOM order
44
-
*[`ally.query.tabsequence`](query/tabsequence.md) finds all keyboard focusable elements in [Sequential Navigation Focus Order](../../concepts.md#Sequential-navigation-focus-order)
44
+
*[`ally.query.tabsequence`](query/tabsequence.md) finds all keyboard focusable elements in [Sequential Navigation Focus Order](../../concepts.md#sequential-navigation-focus-order)
45
45
46
46
47
47
## Element state
48
48
49
-
Unlike any other ally modules, these components do not take take [`options.context` argument](concepts.md#Single-options-argument), but expect the `element` as first argument, allowing easy use in [`.filter()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). See [what does "focusable" mean?](../what-is-focusable.md) for a differentiation.
49
+
Unlike any other ally modules, these components do not take take [`options.context` argument](concepts.md#single-options-argument), but expect the `element` as first argument, allowing easy use in [`.filter()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). See [what does "focusable" mean?](../what-is-focusable.md) for a differentiation.
50
50
51
51
*[`ally.is.activeElement`](is/active-element.md) returns true if the element is the activeElement of its host context, i.e. its document, iFrame or ShadowHost
52
52
*[`ally.is.disabled`](is/disabled.md) returns true if the element is `:disabled`
Copy file name to clipboardExpand all lines: docs/api/concepts.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ While most services will only return an object containing the `disengage()` func
76
76
77
77
### Global service
78
78
79
-
A Global Service (`<global-service>`) is a component that exposes [Service](#Service) API, but will only start a single instance and keep track of its users. This allows ally.js to get by without a service registry in order to reduce complexity. Global Services don't have any arguments and always return the same handle object.
79
+
A Global Service (`<global-service>`) is a component that exposes [Service](#service) API, but will only start a single instance and keep track of its users. This allows ally.js to get by without a service registry in order to reduce complexity. Global Services don't have any arguments and always return the same handle object.
Copy file name to clipboardExpand all lines: docs/api/element/disabled.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Makes an element inert, i.e. not editable.
12
12
13
13
HTML knows the [`:disabled`](https://developer.mozilla.org/en-US/docs/Web/CSS/%3Adisabled) state for form elements, but lacks something similar for all the other interactive elements. This utility makes a form of this convenient state available to every element.
14
14
15
-
Elements that were made inert by [`ally.element.disabled`](#ally.element.disabled) can be identified in the DOM by the attribute `[data-ally-disabled="true"]` to align with styling of other `:disabled` elements.
15
+
Elements that were made inert by [`ally.element.disabled`](#allyelementdisabled) can be identified in the DOM by the attribute `[data-ally-disabled="true"]` to align with styling of other `:disabled` elements.
16
16
17
17
The following things are done in order to make an element inert:
18
18
@@ -43,7 +43,7 @@ var isDisabled = ally.element.disabled(element);
43
43
44
44
| Name | Type | Default | Description |
45
45
| ---- | ---- | ------- | ----------- |
46
-
| element |[`<selector>`](../concepts.md#Selector)|*required*| The Element to modify. First element of the collections is used. |
46
+
| element |[`<selector>`](../concepts.md#selector)|*required*| The Element to modify. First element of the collections is used. |
47
47
| state | boolean, `undefined`|`undefined`|`true` to disable the element, `false` to enable the element. |
48
48
49
49
@@ -80,8 +80,8 @@ In Google Chrome `<audio controls>` and `<video controls>` elements are made ine
80
80
81
81
## Related resources
82
82
83
-
*[`ally.is.disabled`](../is/disabled.md) is able to identify elements disabled by [`ally.element.disabled`](#ally.element.disabled)
84
-
*[`ally.maintain.disabled`](../maintain/disabled.md) is a [service](../concepts.md#Service) finding focusable elements and disabling them within the DOM
83
+
*[`ally.is.disabled`](../is/disabled.md) is able to identify elements disabled by [`ally.element.disabled`](#allyelementdisabled)
84
+
*[`ally.maintain.disabled`](../maintain/disabled.md) is a [service](../concepts.md#service) finding focusable elements and disabling them within the DOM
Copy file name to clipboardExpand all lines: docs/api/fix/pointer-focus-children.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -50,11 +50,11 @@ var handle = ally.fix.pointerFocusChildren({
50
50
51
51
| Name | Type | Default | Description |
52
52
| ---- | ---- | ------- | ----------- |
53
-
| context |[`<selector>`](../concepts.md#Selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
53
+
| context |[`<selector>`](../concepts.md#selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
54
54
55
55
### Returns
56
56
57
-
A [`<service>`](../concepts.md#Service) interface, providing the `handle.disengage()` method to stop the service.
57
+
A [`<service>`](../concepts.md#service) interface, providing the `handle.disengage()` method to stop the service.
Copy file name to clipboardExpand all lines: docs/api/fix/pointer-focus-input.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -34,11 +34,11 @@ var handle = ally.fix.pointerFocusInput({
34
34
35
35
| Name | Type | Default | Description |
36
36
| ---- | ---- | ------- | ----------- |
37
-
| context |[`<selector>`](../concepts.md#Selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
37
+
| context |[`<selector>`](../concepts.md#selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
38
38
39
39
### Returns
40
40
41
-
A [`<service>`](../concepts.md#Service) interface, providing the `handle.disengage()` method to stop the service.
41
+
A [`<service>`](../concepts.md#service) interface, providing the `handle.disengage()` method to stop the service.
Copy file name to clipboardExpand all lines: docs/api/fix/pointer-focus-parent.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -39,11 +39,11 @@ var handle = ally.fix.pointerFocusParent({
39
39
40
40
| Name | Type | Default | Description |
41
41
| ---- | ---- | ------- | ----------- |
42
-
| context |[`<selector>`](../concepts.md#Selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
42
+
| context |[`<selector>`](../concepts.md#selector)|[`document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)| The scope of the DOM in which to apply the fix. All elements of the collections are used. |
43
43
44
44
### Returns
45
45
46
-
A [`<service>`](../concepts.md#Service) interface, providing the `handle.disengage()` method to stop the service.
46
+
A [`<service>`](../concepts.md#service) interface, providing the `handle.disengage()` method to stop the service.
Copy file name to clipboardExpand all lines: docs/api/get/insignificant-branches.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -39,8 +39,8 @@ var elements = ally.get.insignificantBranches({
39
39
40
40
| Name | Type | Default | Description |
41
41
| ---- | ---- | ------- | ----------- |
42
-
| context |[`<selector>`](../concepts.md#Selector)|[`documentElement`](https://developer.mozilla.org/en-US/docs/Web/API/Document/documentElement)| The scope of the DOM in which to search. The first element of a collection is used. |
43
-
| filter |[`<selector>`](../concepts.md#Selector)|*required*| The *significant elements* to exclude from the search. |
42
+
| context |[`<selector>`](../concepts.md#selector)|[`documentElement`](https://developer.mozilla.org/en-US/docs/Web/API/Document/documentElement)| The scope of the DOM in which to search. The first element of a collection is used. |
43
+
| filter |[`<selector>`](../concepts.md#selector)|*required*| The *significant elements* to exclude from the search. |
44
44
45
45
### Returns
46
46
@@ -65,7 +65,7 @@ Array of [`HTMLElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLEleme
65
65
66
66
## Related resources
67
67
68
-
*[`ally.maintain.hidden`](../maintain/hidden.md) is a [service](../concepts.md#Service) hiding insignificant branches from the [Accessibility Tree](../../concepts.md#Accessibility-tree)
68
+
*[`ally.maintain.hidden`](../maintain/hidden.md) is a [service](../concepts.md#service) hiding insignificant branches from the [Accessibility Tree](../../concepts.md#accessibility-tree)
Copy file name to clipboardExpand all lines: docs/api/is/focus-relevant.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -28,12 +28,12 @@ var isFocusRelevant = ally.is.focusRelevant(element);
28
28
| ---- | ---- | ------- | ----------- |
29
29
| element |[`HTMLElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLElement)|*required*| The Element to test. |
30
30
31
-
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#Single-options-argument) by calling `ally.is.focusRelevant.rules(options)`:
31
+
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#single-options-argument) by calling `ally.is.focusRelevant.rules(options)`:
32
32
33
33
| Name | Type | Default | Description |
34
34
| ---- | ---- | ------- | ----------- |
35
-
| context |[`<selector>`](../concepts.md#Selector)|*required*| The element to examine. The first element of a collection is used. |
36
-
| except |[`<focus identification exception>`](../concepts.md#Focus-identification-exceptions)|`{}`| The Element to test. |
35
+
| context |[`<selector>`](../concepts.md#selector)|*required*| The element to examine. The first element of a collection is used. |
36
+
| except |[`<focus identification exception>`](../concepts.md#focus-identification-exceptions)|`{}`| The Element to test. |
Copy file name to clipboardExpand all lines: docs/api/is/focusable.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -28,12 +28,12 @@ var isFocusable = ally.is.focusable(element);
28
28
| ---- | ---- | ------- | ----------- |
29
29
| element |[`HTMLElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLElement)|*required*| The Element to test. |
30
30
31
-
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#Single-options-argument) by calling `ally.is.focusable.rules(options)`:
31
+
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#single-options-argument) by calling `ally.is.focusable.rules(options)`:
32
32
33
33
| Name | Type | Default | Description |
34
34
| ---- | ---- | ------- | ----------- |
35
-
| context |[`<selector>`](../concepts.md#Selector)|*required*| The element to examine. The first element of a collection is used. |
36
-
| except |[`<focus identification exception>`](../concepts.md#Focus-identification-exceptions)|`{}`| The Element to test. |
35
+
| context |[`<selector>`](../concepts.md#selector)|*required*| The element to examine. The first element of a collection is used. |
36
+
| except |[`<focus identification exception>`](../concepts.md#focus-identification-exceptions)|`{}`| The Element to test. |
37
37
38
38
### Returns
39
39
@@ -57,7 +57,7 @@ Boolean, `true` if the element is focusable.
57
57
58
58
## Notes
59
59
60
-
See [`ally.is.focusRelevant`](./focus-relevant.md#Notes)
60
+
See [`ally.is.focusRelevant`](./focus-relevant.md#notes)
Copy file name to clipboardExpand all lines: docs/api/is/only-tabbable.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -28,12 +28,12 @@ var isOnlyTabbable = ally.is.onlyTabbable(element);
28
28
| ---- | ---- | ------- | ----------- |
29
29
| element |[`HTMLElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLElement)|*required*| The Element to test. |
30
30
31
-
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#Single-options-argument) by calling `ally.is.onlyTabbable.rules(options)`:
31
+
The underlying rules can also be accessed in the [`options` argument style](../concepts.md#single-options-argument) by calling `ally.is.onlyTabbable.rules(options)`:
32
32
33
33
| Name | Type | Default | Description |
34
34
| ---- | ---- | ------- | ----------- |
35
-
| context |[`<selector>`](../concepts.md#Selector)|*required*| The element to examine. The first element of a collection is used. |
36
-
| except |[`<focus identification exception>`](../concepts.md#Focus-identification-exceptions)|`{}`| The Element to test. |
35
+
| context |[`<selector>`](../concepts.md#selector)|*required*| The element to examine. The first element of a collection is used. |
36
+
| except |[`<focus identification exception>`](../concepts.md#focus-identification-exceptions)|`{}`| The Element to test. |
37
37
38
38
### Returns
39
39
@@ -57,7 +57,7 @@ Boolean, `true` if the element is only tabbable.
57
57
58
58
## Notes
59
59
60
-
See [`ally.is.focusRelevant`](./focus-relevant.md#Notes)
60
+
See [`ally.is.focusRelevant`](./focus-relevant.md#notes)
61
61
62
62
:::note
63
63
There is no way to feature detect if an element is tabbable or not. The `Element.tabIndex` property gives some indication, but ultimately user agent sniffing (via [platform.js](https://github.com/bestiejs/platform.js/)) is done internally to fix mismatches.
0 commit comments