@useloops/design-system
Version:
The official React based Loops design system
34 lines (31 loc) • 867 B
TypeScript
import { FunctionComponent } from 'react';
import { AvatarProps } from '../Avatar/Avatar.js';
interface FlagProps {
/**
* ISO 3166-1-alpha-2 country code (e.g., 'us', 'gb', 'de')
* or locale string with format 'lang_country' (e.g., 'eng_us', 'deu_de')
*/
countryCode: string;
/**
* Optional className to pass to the span element
*/
className?: string;
slotProps?: {
avatar?: AvatarProps;
};
}
/**
* Flag component displays a country flag based on ISO 3166-1-alpha-2 country codes.
* It supports both direct country codes ('us') and locale formats ('eng_us').
*
* @example
* // Direct country code
* <Flag countryCode="de" />
*
* @example
* // Locale format
* <Flag countryCode="eng_us" />
*/
declare const Flag: FunctionComponent<FlagProps>;
export { Flag as default };
export type { FlagProps };