react-parallax/@types/index.ts

A React Component for parallax effect working in client-side and server-side rendering environment

import React, { ReactNode } from 'react';

export type DynamicBlurProp = { min: number; max: number };
export type BlurProp = number | DynamicBlurProp;
export type BgImageProp = string;
export type BgImageSrcSetProp = string;
export type BgImageSizesProp = string;
export interface SplitChildrenResultType {
    bgChildren: Array<ReactNode>;
    children: Array<ReactNode>;
}

export type ParallaxProps = {
    bgClassName?: string;
    bgImage?: BgImageProp;
    bgImageAlt?: string;
    bgImageSizes?: BgImageSizesProp;
    bgImageSrcSet?: BgImageSrcSetProp;
    bgImageStyle?: { [key: string]: any };
    onLoad?: (event: Event) => void;
    bgStyle?: { [key: string]: any };
    blur?: BlurProp;
    children?: React.ReactNode;
    className?: string;
    contentClassName?: string;
    disabled?: boolean;
    parent?: HTMLElement;
    renderLayer?: (percentage: number) => any;
    strength?: number;
    style?: { [key: string]: any };
    lazy?: boolean;
};

type ParallaxState = {
    bgImage: string;
    bgImageSrcSet: string;
    bgImageSizes: string;
    bgStyle?: { [key: string]: any };
    imgStyle: { [key: string]: any };
    percentage: number;
    splitChildren: SplitChildrenResultType;
};

export type BackgroundProps = {
    className?: string;
    children?: React.ReactNode
};

export type ParallaxChildrenProps = {
    className?: string;
    children?: React.ReactNode;
    onMount(node: HTMLDivElement): void;
};

export class Parallax extends React.Component<ParallaxProps, ParallaxState> {}

export class Background extends React.Component<BackgroundProps, {}> {}

export interface StyleObjectType {
    [key: string]: string;
}