DefinitelyTyped/react-imageloader/index.d.ts
Eric Anderson 9b53298395 Support Pick<> on setState now that TS 2.1 is out (#13155)
* Support Partial<> on setState now that TS 2.1 is out

* Update readme to reflect setState being typed correctly

* Switch setState to Pick

* Restore cloneELement portion of readme

* Use Pick<> | S for setState due to cast issue

* state and props should be readonly

* Fix nit + document why we

* Add typescript compiler header

* Update to properly order headers

* Update readme to reflect 2.1.5 fixing stPick

* Update readme now that 2.1.5 is out

* All that depend on react now require 2.1

* Fix definition that fails due to readonly state
2017-01-23 12:36:53 -08:00

40 lines
1.4 KiB
TypeScript

// Type definitions for react-imageloader 2.1.0
// Project: https://github.com/hzdg/react-imageloader
// Definitions by: Stephen Jelfs <https://github.com/stephenjelfs>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1
/// <reference types="react" />
declare module "react-imageloader" {
interface ImageLoaderProps extends React.Props<ImageLoader> {
/** An optional class name for the wrapper component. */
className?: string;
/** An optional object containing props for the underlying img component. */
imgProps?: any;
/** An optional handler for the error event. */
onError?: (event: any) => void;
/** An optional handler for the load event. */
onLoad?: (event: any) => void;
/** An optional function that returns a React element to be shown while the image loads. */
preloader?: (params: any) => React.ReactElement<any>;
/** The URL of the image to be loaded. */
src: string;
/** An optional object containing styles for the wrapper component. */
style?: React.CSSProperties;
/** A function that takes a props argument and returns a React element to be used as the wrapper component. Defaults to React.DOM.span. */
wrapper?: (props: any) => React.ReactElement<any>;
}
class ImageLoader extends React.Component<ImageLoaderProps, {}> {}
export = ImageLoader;
}