Function useOUIAProps

Hooks version of the getOUIAProps function that also memoizes the generated ID Can only be used in functional components

  • useOUIAProps(componentType, id?, ouiaSafe?, variant?): {
        data-ouia-component-id: OuiaId;
        data-ouia-component-type: string;
        data-ouia-safe: boolean;
    }

  • Parameters

    • componentType: string

      OUIA component type

    • Optionalid: OuiaId

      OUIA component id

    • OptionalouiaSafe: boolean

      false if in animation

    • Optionalvariant: string

      Optional variant to add to the generated ID

    Returns {
        data-ouia-component-id: OuiaId;
        data-ouia-component-type: string;
        data-ouia-safe: boolean;
    }

    • data-ouia-component-id: OuiaId
    • data-ouia-component-type: string
    • data-ouia-safe: boolean

Settings

Member Visibility