/** * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). * * WSO2 LLC. licenses this file to you under the Apache License, * Version 2.0 (the "License"); you may not use this file except * in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import type { ForwardRefExoticComponent, HTMLAttributes } from 'react'; export type CountryFlagProps = { /** * The two-letter/three-letter/three-digit country code of the flag. */ countryCode: string; /** * The height of the flag. */ height?: string; } & HTMLAttributes; /** * @deprecated Use the {@link CountryFlagProps} instead. * This will be removed in the next major release (v2.0.0). */ export type CountryFlagsProps = CountryFlagProps; /** * The Toggle to switch between the two palette modes: light (the default) and dark. * * Demos: * * - [Country Flag (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/icons-country-flags) * * @remarks * - ✨ This is a custom component that is not available in the Material-UI library. * - ✔️ Props of the native component are also available. * - ❌ `component` prop is not supported. * - ✅ The `ref` is forwarded to the root element. * * @param props - The props for the CountryFlag component. * @param ref - The ref to be forwarded to the WorldFlag component. * @returns The rendered CountryFlag component. */ declare const CountryFlag: ForwardRefExoticComponent; export default CountryFlag;