From 804f925d92cb77890a9ed2b176bbe3eae6ee6d9c Mon Sep 17 00:00:00 2001 From: Austin Date: Mon, 30 Oct 2017 16:35:32 -0500 Subject: [PATCH] docs(focus): Add docs for regions #8082 (#8128) * docs(focus): Add docs for regions #8082 * docs(a11y): add more desc for focus trap --- src/cdk/a11y/a11y.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/cdk/a11y/a11y.md b/src/cdk/a11y/a11y.md index c42198d5cba..548326f0bcc 100644 --- a/src/cdk/a11y/a11y.md +++ b/src/cdk/a11y/a11y.md @@ -68,6 +68,22 @@ This directive is declared in `A11yModule`. This directive will not prevent focus from moving out of the trapped region due to mouse interaction. +#### Regions +Regions can be declared explicitly with an initial focus element by using +the `cdkFocusRegionStart`, `cdkFocusRegionEnd` and `cdkFocusInitial` DOM attributes. +`cdkFocusInitial` specifies the element that will receive focus upon initialization of the region. +`cdkFocusRegionStart` and `cdkFocusRegionEnd` define the region within which focus will be +trapped. When using the tab key, focus will move through this region and wrap around on either end. + +For example: + +```html +Focus region start +Link +Initially focused +Focus region end +``` + ### InteractivityChecker `InteractivityChecker` is used to check the interactivity of an element, capturing disabled,