CIA Compliance Manager — API Documentation - v1.1.50
    Preparing search index...

    Function getWidgetAriaDescription

    • Create an accessible description for a widget

      Generates descriptive ARIA descriptions for widgets to provide context to screen reader users about the widget's purpose and content.

      Parameters

      • widgetType: string

        Type of widget (e.g., 'Security Metrics', 'Risk Analysis')

      • Optionaldescription: string

        Optional additional description

      Returns string

      An accessible description string

      // Without additional description
      getWidgetAriaDescription('Security Metrics')
      // 'Security Metrics widget'

      // With additional description
      getWidgetAriaDescription('Risk Analysis', 'Shows current risk levels')
      // 'Risk Analysis widget. Shows current risk levels'

      getWidgetAriaDescription('Cost Estimation', 'CAPEX and OPEX breakdown')
      // 'Cost Estimation widget. CAPEX and OPEX breakdown'

      // Usage in component
      <div
      role="region"
      aria-label={widgetTitle}
      aria-describedby="widget-desc"
      >
      <span id="widget-desc" className="sr-only">
      {getWidgetAriaDescription(widgetType, description)}
      </span>
      {widgetContent}
      </div>