@payfit/unity-components
Version:
47 lines (46 loc) • 1.69 kB
TypeScript
import { SVGAttributes } from 'react';
export type PayfitAIBrandProps = Omit<SVGAttributes<SVGSVGElement>, 'width' | 'height'> & {
/**
* Sets the square width and height of the mark in pixels.
* @default 28
*/
size?: number;
/**
* Selects the full-color or disabled grayscale treatment.
* @default 'color'
*/
appearance?: 'color' | 'grayscale';
};
/**
* Renders the square PayFit AI brand mark used to identify AI Kit surfaces.
*
* Use the default `color` appearance for available AI actions. Set
* `appearance="grayscale"` when the adjacent control is disabled or loading.
* Pass `aria-hidden="true"` when nearby text already names the AI action;
* otherwise the mark exposes the accessible name “Payfit AI” by default.
* @param props - SVG attributes and PayFit AI brand options.
* @see {@link PayfitAIBrandProps} for size and appearance options.
* @example
* ```tsx
* import { PayfitAIBrand } from '@payfit/unity-components/ai-kit'
*
* export function AIActionLabel() {
* return <PayfitAIBrand size={24} aria-label="Payfit AI" />
* }
* ```
* @remarks
* - The SVG preserves a square aspect ratio at every size.
* - It renders with `role="img"` unless it is decorative.
*/
export declare const PayfitAIBrand: import('react').ForwardRefExoticComponent<Omit<SVGAttributes<SVGSVGElement>, "height" | "width"> & {
/**
* Sets the square width and height of the mark in pixels.
* @default 28
*/
size?: number;
/**
* Selects the full-color or disabled grayscale treatment.
* @default 'color'
*/
appearance?: "color" | "grayscale";
} & import('react').RefAttributes<SVGSVGElement>>;