next/dist/client/route-announcer.js

The React Framework

"use strict";
Object.defineProperty(exports, "__esModule", {
    value: true
});
exports.RouteAnnouncer = RouteAnnouncer;
exports.default = void 0;
var _react = _interopRequireDefault(require("react"));
var _router = require("./router");
function _interopRequireDefault(obj) {
    return obj && obj.__esModule ? obj : {
        default: obj
    };
}
function RouteAnnouncer() {
    const { asPath  } = (0, _router).useRouter();
    const [routeAnnouncement, setRouteAnnouncement] = _react.default.useState('');
    // Only announce the path change, but not for the first load because screen reader will do that automatically.
    const initialPathLoaded = _react.default.useRef(false);
    // Every time the path changes, announce the route change. The announcement will be prioritized by h1, then title
    // (from metadata), and finally if those don't exist, then the pathName that is in the URL. This methodology is
    // inspired by Marcy Sutton's accessible client routing user testing. More information can be found here:
    // https://www.gatsbyjs.com/blog/2019-07-11-user-testing-accessible-client-routing/
    _react.default.useEffect(()=>{
        if (!initialPathLoaded.current) {
            initialPathLoaded.current = true;
            return;
        }
        let newRouteAnnouncement;
        const pageHeader = document.querySelector('h1');
        if (pageHeader) {
            newRouteAnnouncement = pageHeader.innerText || pageHeader.textContent;
        }
        if (!newRouteAnnouncement) {
            if (document.title) {
                newRouteAnnouncement = document.title;
            } else {
                newRouteAnnouncement = asPath;
            }
        }
        setRouteAnnouncement(newRouteAnnouncement);
    }, // TODO: switch to pathname + query object of dynamic route requirements
    [
        asPath
    ]);
    return(/*#__PURE__*/ _react.default.createElement("p", {
        "aria-live": "assertive" // Make the announcement immediately.
        ,
        id: "__next-route-announcer__",
        role: "alert",
        style: {
            border: 0,
            clip: 'rect(0 0 0 0)',
            height: '1px',
            margin: '-1px',
            overflow: 'hidden',
            padding: 0,
            position: 'absolute',
            width: '1px',
            // https://medium.com/@jessebeach/beware-smushed-off-screen-accessible-text-5952a4c2cbfe
            whiteSpace: 'nowrap',
            wordWrap: 'normal'
        }
    }, routeAnnouncement));
}
var _default = RouteAnnouncer;
exports.default = _default;

//# sourceMappingURL=route-announcer.js.map