DefinitelyTyped/types/react-fa/index.d.ts
2017-08-17 14:53:41 -07:00

47 lines
1.6 KiB
TypeScript

// Type definitions for react-fa 4.1
// Project: https://github.com/andreypopp/react-fa
// Definitions by: Frank Laub <https://github.com/flaub>, Pat Sissons <https://github.com/patsissons>, Karol Janyst <https://github.com/LKay>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
import { Component, ComponentClass, HTMLProps, StatelessComponent, ReactElement } from "react";
// fake intermediate interface to remove typing on size, as the typing
// is overrided by react-fa
interface SizeOverrideHTMLProps<T> extends HTMLProps<T> {
size?: any;
}
export type IconSize = "lg" | "2x" | "3x" | "4x" | "5x";
export type IconRotation = "45" | "90" | "135" | "180" | "225" | "270" | "315";
export type IconFlip = "horizontal" | "vertical";
export type IconStackSize = "1x" | "2x";
type CustomComponent = string | ComponentClass<any> | StatelessComponent<any>;
export interface IconProps extends SizeOverrideHTMLProps<Icon> {
name: string;
size?: IconSize;
spin?: boolean;
rotate?: IconRotation;
flip?: IconFlip;
fixedWidth?: boolean;
pulse?: boolean;
stack?: IconStackSize;
inverse?: boolean;
Component?: CustomComponent;
}
export type Icon = Component<IconProps>;
export const Icon: ComponentClass<IconProps>;
export interface IconStackProps extends SizeOverrideHTMLProps<IconStack> {
size?: IconSize;
children?: ReactElement<IconProps> | Array<ReactElement<IconProps>>;
}
export type IconStack = Component<IconStackProps>;
export const IconStack: ComponentClass<IconStackProps>;
export default Icon;