CIA Compliance Manager API Documentation - v1.0.1
    Preparing search index...

    Interface ComplianceWidgetProps

    Props for widgets that display compliance status

    Compliance widgets help organizations understand how their security settings align with regulatory requirements, enabling them to identify gaps and satisfy audit requirements. 📋

    interface ComplianceWidgetProps {
        availabilityLevel: SecurityLevel;
        children?: ReactNode;
        className?: string;
        confidentialityLevel: SecurityLevel;
        integrityLevel: SecurityLevel;
        onAvailabilityChange?: (level: SecurityLevel) => void;
        onConfidentialityChange?: (level: SecurityLevel) => void;
        onError?: (error: Error) => void;
        onIntegrityChange?: (level: SecurityLevel) => void;
        refreshTrigger?: number;
        testId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    availabilityLevel children? className? confidentialityLevel integrityLevel onAvailabilityChange? onConfidentialityChange? onError? onIntegrityChange? refreshTrigger? testId?

    Properties

    availabilityLevel: SecurityLevel

    The selected availability level

    Controls system uptime and accessibility requirements.

    'High'
    children?: ReactNode

    Optional children elements

    className?: string

    Optional CSS class name for custom styling

    Allows consumers to apply custom styles via CSS classes. Use Tailwind CSS classes or custom CSS classes.

    "mt-4 border-2 rounded-lg"
    confidentialityLevel: SecurityLevel

    The selected confidentiality level

    Controls data privacy and access control requirements.

    'Moderate'
    integrityLevel: SecurityLevel

    The selected integrity level

    Controls data accuracy and consistency requirements.

    'Very High'
    onAvailabilityChange?: (level: SecurityLevel) => void

    Optional callback fired when availability level changes

    Type Declaration

    onAvailabilityChange={(level) => {
      console.log('New availability level:', level);
      updateConfiguration('availability', level);
    }}
    onConfidentialityChange?: (level: SecurityLevel) => void

    Optional callback fired when confidentiality level changes

    Type Declaration

    onConfidentialityChange={(level) => {
      console.log('New confidentiality level:', level);
      updateConfiguration('confidentiality', level);
    }}
    onError?: (error: Error) => void

    Optional callback when widget encounters an error

    Type Declaration

      • (error: Error): void

      • Parameters

        • error: Error

          Error that occurred

        Returns void

    onIntegrityChange?: (level: SecurityLevel) => void

    Optional callback fired when integrity level changes

    Type Declaration

    onIntegrityChange={(level) => {
      console.log('New integrity level:', level);
      updateConfiguration('integrity', level);
    }}
    refreshTrigger?: number

    Optional refresh trigger to reload data

    testId?: string

    Optional test ID for automated testing

    Used by testing frameworks (Cypress, Vitest) to locate and interact with the component. Should follow the pattern defined in testIds constants.

    "security-widget-availability"

    Settings

    Member Visibility

    On This Page

    Business Perspective
    Properties