Keylinks

Keylinks are special blocks designed to improve accessibility for users. These elements are essential for enhancing the site's keyboard navigation experience.

KeylinkToContent

A special element that appears at the very start of the page when the user presses the tab key for the first time. When clicked, it moves the focus to the main content of the page — the documentation itself.

This element should be inserted at the very beginning of the page, i.e., the first element in the body.

TypeScript

JavaScript

import { Header, KeylinkToContent } from "robindoc";

const RootLayout: React.FC<React.PropsWithChildren> = ({ children }) => (
  <html lang="en">
    <body>
      <KeylinkToContent />
      <Header logo={<Logo />} />
      {/* ... */}
    </body>
  </html>
);

export default RootLayout;

import { Header, KeylinkToContent } from "robindoc";

const RootLayout = ({ children }) => (
  <html lang="en">
    <body>
      <KeylinkToContent />
      <Header logo={<Logo />} />
      {/* ... */}
    </body>
  </html>
);

export default RootLayout;

If you use this separately from the Page component, assign the page content element the attribute id="main-content".

Props

translations [{ [key: string]: string }] - translations for the current block. The key is the term identifier, and the value is the corresponding translation. For the latest list of terms, check the editor hints.

KeylinkToNavigation

A special element that appears at the very end of the page when navigating using the tab key. When clicked, it moves the focus to the documentation's navigation.

This element should be inserted at the very end of the page, i.e., the last element in the body.

KeylinkToNavigation should be added at the page level in case there are pages without navigation.

TypeScript

JavaScript

import { DocsContainer, KeylinkToNavigation } from "robindoc";

import { Sidebar } from "./robindoc";

const DocsLayout: React.FC<React.PropsWithChildren> = ({ children }) => (
  <DocsContainer>
    <Sidebar />
    {children}
    <KeylinkToNavigation />
  </DocsContainer>
);

export default DocsLayout;

import { DocsContainer, KeylinkToNavigation } from "robindoc";

import { Sidebar } from "./robindoc";

const DocsLayout = ({ children }) => (
  <DocsContainer>
    <Sidebar />
    {children}
    <KeylinkToNavigation />
  </DocsContainer>
);

export default DocsLayout;

It should be used together with the Sidebar component. If you use your own navigation component, assign it the attribute id="navigation".

Props

Previous
Header Next
Page