UNPKG

1.36 kBTypeScriptView Raw
1/// <reference types="react" />
2import { CSSProperties, SVGAttributes } from 'react'
3import {
4 Transform,
5 IconProp,
6 FlipProp,
7 SizeProp,
8 PullProp,
9 RotateProp,
10 FaSymbol
11} from '@fortawesome/fontawesome-svg-core'
12
13export function FontAwesomeIcon(props: FontAwesomeIconProps): JSX.Element
14
15/**
16 * @deprecated use FontAwesomeIconProps
17 */
18export type Props = FontAwesomeIconProps
19
20// This is identical to the version of Omit in Typescript 3.5. It is included for compatibility with older versions of Typescript.
21type BackwardCompatibleOmit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
22
23export interface FontAwesomeIconProps extends BackwardCompatibleOmit<SVGAttributes<SVGSVGElement>, 'children' | 'mask' | 'transform'> {
24 forwardedRef?: ((e: any) => void) | React.MutableRefObject<any> | null
25 icon: IconProp
26 mask?: IconProp
27 maskId?: string
28 className?: string
29 color?: string
30 spin?: boolean
31 pulse?: boolean
32 beat?: boolean
33 fade?: boolean
34 beatFade?: boolean
35 bounce?: boolean
36 shake?: boolean
37 border?: boolean
38 fixedWidth?: boolean
39 inverse?: boolean
40 listItem?: boolean
41 flip?: FlipProp
42 size?: SizeProp
43 pull?: PullProp
44 rotation?: RotateProp
45 transform?: string | Transform
46 symbol?: FaSymbol
47 style?: CSSProperties
48 tabIndex?: number;
49 title?: string;
50 titleId?: string;
51 swapOpacity?: boolean;
52}
53
\No newline at end of file