Skip to content

Commit 726b4cf

Browse files
authored
chore: Ionic 8.1 docs
2 parents ef11edf + fb7c818 commit 726b4cf

File tree

14 files changed

+464
-54
lines changed

14 files changed

+464
-54
lines changed

docs/api/content.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ import Fullscreen from '@site/static/usage/v8/content/fullscreen/index.md';
5454

5555
To place elements outside of the scrollable area, assign them to the `fixed` slot. Doing so will [absolutely position](https://developer.mozilla.org/en-US/docs/Web/CSS/position#absolute_positioning) the element to the top left of the content. In order to change the position of the element, it can be styled using the [top, right, bottom, and left](https://developer.mozilla.org/en-US/docs/Web/CSS/position) CSS properties.
5656

57+
The `fixedSlotPlacement` property is used to determine if content in the `fixed` slot is placed before or after the main content in the DOM. When set to `before`, fixed slot content will be placed before the main content and will therefore receive keyboard focus before the main content receives keyboard focus. This can be useful when the main content contains an infinitely-scrolling list, preventing a [FAB](./fab) or other fixed content from being reachable by pressing the tab key.
58+
5759
import Fixed from '@site/static/usage/v8/content/fixed/index.md';
5860

5961
<Fixed />

docs/api/datetime.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -443,14 +443,7 @@ dates in JavaScript.
443443

444444
#### Time, Month, and Year Wheels
445445

446-
When using the time wheel picker, you can use the number keys to select hour and minute values when the columns are focused.
447-
448-
| Key | Function |
449-
| ------------------ | ------------------------------------------------------------ |
450-
| `ArrowUp` | Scroll to the previous item. |
451-
| `ArrowDown` | Scroll to the next item. |
452-
| `Home` | Scroll to the first item. |
453-
| `End` | Scroll to the last item. |
446+
The wheel picker in Datetime uses [Picker](./picker) internally. See [Picker Accessibility](./picker#accessibility) for more information on accessibility features with the wheel picker.
454447

455448
## Interfaces
456449

docs/api/fab.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@ import SafeArea from '@site/static/usage/v8/fab/safe-area/index.md';
6767

6868
<SafeArea />
6969

70+
### Relative to Infinite List
71+
72+
In scenarios where a view contains many interactive elements, such as an infinitely-scrolling list, it may be challenging for users to navigate to the Floating Action Button (FAB) if it is placed below all the items in the DOM.
73+
74+
By setting the `fixedSlotPlacement` property on [Content](./content) to `before`, the FAB will be placed before the main content in the DOM. This ensures that the FAB receives keyboard focus before other interactive elements receive focus, making it easier for users to access the FAB.
75+
76+
import BeforeContent from '@site/static/usage/v8/fab/before-content/index.md';
77+
78+
<BeforeContent />
79+
7080
## Button Sizing
7181

7282
Setting the `size` property of the main fab button to `"small"` will render it at a mini size. Note that this property will not have an effect when used with the inner fab buttons.

docs/api/picker.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,37 @@ Pickers can be displayed inside of overlays, such as `ion-modal` to create a pic
4848
import ModalExample from '@site/static/usage/v8/picker/modal/index.md';
4949

5050
<ModalExample />
51+
52+
## Accessibility
53+
54+
### Screen Readers
55+
56+
Picker supports navigation using a screen reader by implementing the [`slider` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role) on each [Picker Column](./picker-column). The following gestures can be used to navigate the Picker.
57+
58+
| Gesture | Function |
59+
| - | - |
60+
| Swipe Left | Move focus to the previous Picker Column. |
61+
| Swipe Right | Move focus to the next Picker Column. |
62+
| Swipe Up | Select the next option in the Picker Column. |
63+
| Swipe Down | Select the previous option in the Picker Column. |
64+
| Double Tap and Slide Up/Down | Adjust the selected option in the Picker Column. Can be used as an alternative to swiping up and down. |
65+
66+
:::caution
67+
The Swipe Up and Swipe Down gestures rely on the correct key events being synthesized as noted on the [`slider` documentation](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role). [Chromium-based browsers do not synthesize keyboard events correctly](https://issues.chromium.org/issues/40816094), but the "Double Tap and Slide Up/Down" gesture can be used as an alternative until this has been implemented in Chromium-based browsers.
68+
:::
69+
70+
### Keyboard Navigation
71+
72+
Each [Picker Column](./picker-column) can be navigated using the keyboard when focused.
73+
74+
| Key | Function |
75+
| ------------------ | ------------------------------------------------------------ |
76+
| `ArrowUp` | Scroll to the previous option. |
77+
| `ArrowDown` | Scroll to the next option. |
78+
| `PageUp` | Scroll up by more than one option. |
79+
| `PageDown` | Scroll down by more than one option. |
80+
| `Home` | Scroll to the first option. |
81+
| `End` | Scroll to the last option. |
5182

5283
## Properties
5384
<Props />

docs/api/title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ When creating headings, we typically recommend using [semantic heading elements
5757

5858
To achieve this, developers should use the [`heading` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) on Title. This will indicate to assistive technologies that Title is a type of heading. From there, developers should use the [`aria-level` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) to set the heading level.
5959

60-
For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title.
60+
For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title. This is necessary when using the [Focus Manager](../developing/managing-focus#assistive-technology-focus-management).
6161

6262
Since multiple Title elements can be used on a view in conjunction with semantic heading elements, Ionic does not automatically set the Title's `role` or `aria-level`. It is the responsibility of the developer to handle this.
6363

0 commit comments

Comments
 (0)