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

    Interface BaseWidgetProps

    Base props common to all widgets

    Provides the foundation for all widget components with standard styling, testing capabilities, error handling, and child content.

    Extends CommonWidgetProps to maintain consistency with existing patterns.

    interface MyWidgetProps extends BaseWidgetProps {
      customProp: string;
    }
    interface BaseWidgetProps {
        children?: ReactNode;
        className?: string;
        onError?: (error: Error) => void;
        testId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children? className? onError? testId?

    Properties

    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"
    onError?: (error: Error) => void

    Optional callback when widget encounters an error

    Type Declaration

      • (error: Error): void

      • Parameters

        • error: Error

          Error that occurred

        Returns void

    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

    Properties