@metreeca/tile
    Preparing search index...
    • Creates a link.

      Shows its content on a native anchor, so the link role, the activation by Enter, the tab stop, the focus ring and the browser's own handling of modified clicks come with it rather than having to be asked for. A plain click on a route of the same site is followed by the enclosing Router without reloading the page.

      An active link, while the route it points at is current, is set apart from its neighbours by an underline in the accent colour, and is announced as the current page, or as the current entry of a section where href covers the routes nested under it, so a navigation menu tells the reader where they are whether or not they see it. The anchor also carries an empty active attribute, for a stylesheet of the consumer's own to read.

      Reads the current route, so it renders below the Router.

      Parameters

      • options: {
            active?: boolean;
            look?: "subtle" | "normal" | "strong";
            href: string;
            title?: string;
            onClick?: (event: TargetedMouseEvent<HTMLAnchorElement>) => void;
            children?: ComponentChildren;
        }

        The widget configuration

        • Optionalactive?: boolean

          Whether the link is marked while the route it points at is current; never marked if omitted.

        • Optionallook?: "subtle" | "normal" | "strong"

          How loud the link appears: subtle reads as the text around it, font and colour alike, normal adds the link colour and an underline, and strong stands as a label of its own, smaller and heavier in the text colour with no underline, as a navigation entry does. However loud, a marked link is underlined in the accent colour, thick except for subtle, where the mark is thinner and closer to the text.

          A link stating nothing takes the look the area around it is written in, from the --tile--look token the design system carries, which is normal where nothing assigns it. Stating a look here answers to that alone.

        • href: string

          The route the link points at; a trailing /* extends the marking of an active link to every route nested under it, so /users/* links to /users/ and is marked for /users/123, though not for /users.

        • Optionaltitle?: string

          The hint the platform shows on resting the pointer on the link, such as where it leads; no hint if omitted.

          Beside content that names the link it names nothing. On a glyph standing alone with no label of its own it names the link, and is then spoken as a name rather than as an aside. Either way it reaches neither a reader who never rests the pointer nor one on a touch screen, so whatever a reader has to take in to follow the link belongs in its content rather than here.

        • OptionalonClick?: (event: TargetedMouseEvent<HTMLAnchorElement>) => void

          What activating the link is handed to, whether the activation comes from a pointer or from Enter; followed as a link if omitted. A link given a handler is never followed, by the enclosing router or by the browser, so the handler alone decides what the activation does, while href still states where the link points. The activation event is handed over as it stands, so a handler may read the modifier keys it carries.

        • Optionalchildren?: ComponentChildren

          The content the link shows, naming it; a glyph standing alone carries a label of its own to be announced by.

      Returns VNode<{ look: "subtle" | "normal" | "strong" | undefined }>

      The link