Axe Reporter Documentation
    Preparing search index...

    Function default

    • A component that displays detailed information about a single accessibility rule check. Shows the rule's help text, description, ID, WCAG tags, and affected nodes.

      Parameters

      • props: {
            rule?: {
                description: string;
                help: string;
                helpUrl: string;
                id: string;
                impact: string;
                nodes: never[];
                tags: never[];
            };
        }

        Component props

        • Optionalrule?: {
              description: string;
              help: string;
              helpUrl: string;
              id: string;
              impact: string;
              nodes: never[];
              tags: never[];
          }

          The accessibility rule data

          • description: string

            Detailed description of the rule

          • help: string

            Help text explaining the rule

          • helpUrl: string

            URL to additional help documentation

          • id: string

            Unique identifier for the rule

          • impact: string

            Impact level of the rule violation

          • nodes: never[]

            Array of DOM nodes affected by the rule

          • tags: never[]

            Array of WCAG tags associated with the rule

      Returns Element

      A detailed view of an accessibility rule check