next-circle-flags/dist/index.d.ts

A Next component with a collection of 300+ minimal circular SVG country flags

import { DetailedHTMLProps, ImgHTMLAttributes } from "react";

interface CircleFlagProps extends DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement> {
  /**
   * Country code of flag.
   */
  countryCode: string;
  /**
   * Custom CDN URL to use.
   */
  cdnUrl?: string;

  /**
   * change quality based on next/image
   */
  quality?: number

  /**
   * A boolean that causes the image to fill the parent element instead of setting width and height.
   */
  fill?: boolean

  height?: number

  width?: number
}

/**
 *
 * Demos:
 * - https://tnovau.github.io/react-circle-flags/gallery
 *
 * Docs:
 * - https://tnovau.github.io/react-circle-flags/
 */
declare function CircleFlag(props: CircleFlagProps): JSX.Element;

declare var countries: Record<string, boolean>;

export { CircleFlag, CircleFlagProps, countries }