The scroll position as x and y coordinates.
A CSS selector.
Specifies an element that is the target of a side effect (e.g. scroll into view, focus). This is either the element itself or a selector that will return the element when passed to querySelector().
Make an announcement to screen reader users. Useful for page navigation events.
See https://almerosteyn.com/2017/03/accessible-react-navigation See https://getbootstrap.com/docs/4.3/utilities/screen-readers/ See https://github.com/twbs/bootstrap/blob/ff29c1224c20b8fcf2d1e7c28426470f1dc3e40d/scss/mixins/_screen-reader.scss#L6
the message to announce to screen reader users, e.g. "navigated to about page".
a DOM ID of the visually hidden announcements element, e.g. "announcements".
Maps from a URL hash fragment to a target element.
Supports "#", "#top" and element IDs. The empty string returns undefined.
Useful for scrolling to the element referred to by the hash fragment in a URL (which browsers do natively, but single page apps often don't).
See https://github.com/rafrex/react-router-hash-link (only manages scroll, not focus) See https://github.com/ReactTraining/react-router/issues/394 See https://www.w3.org/TR/html5/single-page.html#scroll-to-the-fragment
the hash fragment, e.g. "#", "#top" or "#my-heading-id"
Focuses a specified element and then scrolls it (or another element) into view (if required).
For smooth scrolling behavior you might want to use the smoothscroll polyfill http://iamdustan.com/smoothscroll/
Focuses an element, setting tabindex="-1" if necessary.
If you specify the preventScroll focus option (which has poor browser support) this function will use a window.scrollTo() hack to emulate the preventScroll option's behavior.
See: https://developer.paciellogroup.com/blog/2014/08/using-the-tabindex-attribute/ See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#Browser_compatibility See: https://github.com/whatwg/html/issues/834 See: https://stackoverflow.com/questions/4963053/focus-to-input-without-scrolling/6610501 See: https://github.com/calvellido/focus-options-polyfill
the element to focus.
focus options.
Focuses and scrolls into view the first invalid form element inside a given form.
For IE support you might want to use the closest() polyfill from https://developer.mozilla.org/en-US/docs/Web/API/Element/closest#Polyfill
a CSS selector that uniquely identifies the form to focus, e.g. #search-form.
the CSS selector that is used to identify invalid elements within a form, e.g. [aria-invalid="true"].
a CSS selector passed to the closest() method of an invalid form input that identifies the element that contains both the form input and its label. This form group element will be scrolled into view so that both the input and its label are visible.
True if the specified element is within the viewport, false otherwise. See https://stackoverflow.com/questions/123999/how-to-tell-if-a-dom-element-is-visible-in-the-current-viewport/7557433#7557433
the element to test
Resets focus after a SPA page navigation.
See: https://github.com/ReactTraining/react-router/issues/5210
a CSS selector for your primary focus target,
e.g. [main h1]. This is the element that will receive focus after SPA
navigation. If this element does not exist the document body will be used
as a fallback.
Scrolls an element into view if it is not currently visible.
For smooth scrolling behavior you might want to use the smoothscroll polyfill http://iamdustan.com/smoothscroll/
the element to scroll into view
controls how the scroll is executed
Set the document title. See https://www.w3.org/TR/UNDERSTANDING-WCAG20/navigation-mechanisms-title.html
The new document title.
Generated using TypeDoc
A hash fragment.