Class AutoSizer<T>

A component that automatically resizes its children based on its parent element's size.

Type Parameters

  • T extends unknown = object

Hierarchy (View Summary)

Constructors

constructor

Properties

_autoSizer? _detectElementResize? _parentNode? _setRef defaultProps lastHeightRequest lastWidthRequest state

Methods

componentDidMount componentWillUnmount render shouldComponentUpdate

Constructors

constructor

  • new AutoSizer<T extends unknown = object>(): AutoSizer<T>

    Type Parameters

    • T extends unknown = object

    Returns AutoSizer<T>

Properties

Optional_autoSizer

_autoSizer?: null | HTMLElement

Optional_detectElementResize

_detectElementResize?: DetectElementResize

Optional_parentNode

_parentNode?: HTMLElement

_setRef

_setRef: (autoSizer: null | HTMLElement) => void

Sets the reference to the autoSizer element.

Type declaration

    • (autoSizer: null | HTMLElement): void

    • Parameters

      • autoSizer: null | HTMLElement

        The autoSizer element or null.

      Returns void

StaticdefaultProps

defaultProps: Partial<IAutoSizerProps<any>>

Default properties for the AutoSizer component.

lastHeightRequest

lastHeightRequest: (h: number) => number

lastWidthRequest

lastWidthRequest: (w: number) => number

state

state: {
    childHeight: number;
    childWidth: number;
    height: number;
    width: number;
}

Represents the state of a component.

Methods

componentDidMount

  • componentDidMount(): void

    Executes after the component has been mounted to the DOM. It sets up the element for resizing and calls the resize event handler.

    Returns void

componentWillUnmount

  • componentWillUnmount(): void

    This method is invoked immediately before a component is unmounted and destroyed.

    It removes the resize listener if it exists and the parent node is defined.

    Returns void

render

  • render(): Element

    Renders a container div with specified child parameters and styles.

    Returns Element

    • The rendered container div element.

    Function

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: IAutoSizerProps<T>, nextState: State): boolean

    Determines whether the component should update based on the changes in the nextProps and nextState.

    Parameters

    • nextProps: IAutoSizerProps<T>

      The next props that will be received by the component.

    • nextState: State

      The next state that will be set in the component.

    Returns boolean

    • Returns true if the component should update, otherwise false.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods