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

A React 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
  /**
   * Whether to use inline SVG rendering.
   */
  inline?: boolean
}

interface CircleFlagLanguageProps extends DetailedHTMLProps<
  ImgHTMLAttributes<HTMLImageElement>,
  HTMLImageElement
> {
  /**
   * Language code of flag.
   */
  languageCode: string
  /**
   * Custom CDN URL to use.
   */
  cdnUrl?: string
  /**
   * Whether to use inline SVG rendering.
   */
  inline?: boolean
}

/**
 *
 * Demos:
 * - https://on-the-edge-cloud.github.io/react-circle-flags/gallery
 *
 * Docs:
 * - https://on-the-edge-cloud.github.io/react-circle-flags/
 */
declare function CircleFlag(props: CircleFlagProps): JSX.Element
declare function CircleFlagLanguage(props: CircleFlagLanguageProps): JSX.Element

declare var countries: Record<string, boolean>
declare var languages: Record<string, boolean>

export { CircleFlag, CircleFlagLanguage, CircleFlagProps, CircleFlagLanguageProps, countries, languages }