Trails Packages
    Preparing search index...

    Interface CommonComponentProps

    Common properties supported by all public react components.

    This type allows for the customization of

    • the css className
    • a Chakra css property
    • "role" and aria-* properties
    • arbitrary data-* properties

    Prop types for react components typically inherit from this interface.

    interface CommonComponentProps {
        className?: string;
        css?: SystemStyleObject | SystemStyleObject[];
        "data-testid"?: string;
        role?: AriaRole;
        [key: `data-${string}`]: unknown;
    }

    Hierarchy

    • AriaAttributes
      • CommonComponentProps

    Indexable

    • [key: `data-${string}`]: unknown

      Arbitrary data attributes.

      NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

    Index

    Properties

    className? css? data-testid? role?

    Properties

    className?: string

    Additional class name(s).

    css?: SystemStyleObject | SystemStyleObject[]

    Custom style rules using Chakra's style objects.

    "data-testid"?: string

    Used for testing.

    role?: AriaRole

    Custom ARIA role.

    Settings

    Member Visibility

    On This Page

    Properties