g3-toolkit API Reference
    Preparing search index...

    Interface AriaCompanionProps

    interface AriaCompanionProps {
        announceDebounceMs?: number;
        announcement?: string;
        className?: string;
        hidden?: ReadonlySet<string>;
        instructions?: string;
        label?: string;
        muted?: boolean;
        summarizeNode?: (ugm: UGM, nodeId: string) => string;
        ugm: UGM;
    }
    Index

    Properties

    announceDebounceMs? announcement? className? hidden? instructions? label? muted? summarizeNode? ugm

    Properties

    announceDebounceMs?: number

    Milliseconds to wait after the last message change before the live region updates, so rapid changes (a slider drag, fast arrowing) collapse to the final one. 0 (default) updates on the same render.

    announcement?: string

    Host-driven message for the live region. Every change is announced (identical consecutive values are not: a live region only speaks on a DOM change, which is also what keeps an unchanged re-render silent). Shares the region with the companion's own navigation announcements; the most recent of the two wins.

    className?: string
    hidden?: ReadonlySet<string>

    Node ids hidden on the canvas (the same set a host passes to CytoscapeCanvas hidden). Hidden nodes leave the list and arrow navigation skips them, so the accessible view and the visible one agree.

    instructions?: string

    One-line usage instructions (how to reach and drive the list), rendered visually hidden and wired as the list's accessible description.

    label?: string

    Accessible name of the node list. Default: "Graph nodes".

    muted?: boolean

    While true the live region is not updated; the latest pending message commits once this flips back to false. Use it to keep a playing animation (a time sweep, a chain walk) from narrating every frame.

    summarizeNode?: (ugm: UGM, nodeId: string) => string

    Formatter for a node's summary: each option's label and the text of the companion's "Navigated to" announcement. The default follows R7.10 (label, types, connection count, breakdown by neighbor type); a host with directed or typed edges supplies the wording its users need, such as incoming/outgoing provenance counts.

    ugm: UGM

    Settings

    Member Visibility

    On This Page

    Properties