# react-lazily-render

> Lazily render react components

Latest version **1.2.0** (published 2019-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-lazily-render
pnpm add react-lazily-render
yarn add react-lazily-render
bun add react-lazily-render
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2019-06-11 |
| First published | 2017-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 72.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Maintainers | jameslnewell |
| Keywords | react, lazy-load, react-lazy-load, lazy, load, delay, expensive, performance |

## Links

- npm: https://www.npmjs.com/package/react-lazily-render
- Repository: https://github.com/jameslnewell/react-lazily-render
- Homepage: https://github.com/jameslnewell/react-lazily-render#readme
- Issues: https://github.com/jameslnewell/react-lazily-render/issues
- npm.io page: https://npm.io/package/react-lazily-render

## Dependencies (1)

- [scrollparent](https://npm.io/package/scrollparent.md) ^2.0.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2019-06-11
- 1.1.0 — 2018-08-14
- 1.0.2 — 2018-07-31
- 1.0.1 — 2018-02-08
- 1.0.0 — 2018-02-01
- 0.0.8 — 2018-01-11
- 0.0.7 — 2018-01-11
- 0.0.6 — 2017-11-29
- 0.0.5 — 2017-11-20
- 0.0.4 — 2017-11-20
- 0.0.3 — 2017-11-20
- 0.0.2 — 2017-11-20
- 0.0.1 — 2017-11-19

## README

# react-lazily-render

[![Build Status](https://travis-ci.org/jameslnewell/react-lazily-render.svg?branch=master)](https://travis-ci.org/jameslnewell/react-lazily-render)

Lazily render react components.

Delay mounting expensive components until a placeholder component has been scrolled into view.

## Installation

```
npm install --save react-lazily-render
```

## Usage

[Example](https://jameslnewell.github.io/react-lazily-render) ([source](https://github.com/jameslnewell/react-lazily-render/blob/master/example/App.js#L8))

```js
import React from 'react';
import LazilyRender from 'react-lazily-render';

<div>
  ...lots of content...
  <LazilyRender
    placeholder={<PlaceholderComponent/>}
    content={<ExpensiveComponent/>}
  />
  ...lots of content...
  <LazilyRender>
    {render => render
      ? <ExpensiveComponent/>
      : <PlaceholderComponent/>
    }
  </LazilyRender>
  ...lots of content...
</div>

```

## API

### Properties

#### className

> `string`

The `className` applied to the wrapping element.

#### component

> `string | React.ComponentClass`

The wrapping component.

e.g. 
```js
<LazilyRender component="span"/>
<LazilyRender component={MyComponent}/>
```

### offset

> `number | {top?: number, right?: number, bottom?: number, left?: number}`

An offset applied to the element for calculating whether the component has been scrolled into view.

You can specify individual values for each side, or a single value used for all sides.

#### placeholder

> `React.Node`

Rendered when the component hasn't been scrolled into view.

#### content

> `React.Node`

Rendered when the component has been scrolled into view.

#### children

> `(render: boolean) => React.Node`

Called to render something depending on whether the component has been scrolled into view.

#### onRender

> `() => void`

Called when the component becomes visible for the first time.

#### scrollContainer

> `HTMLElement | undefined`

The container which `react-lazily-render` listens to for scroll events.

This property can be used in a scenario where you want to specify your own scroll container - e.g. if the component you are rendering is asynchronously added to the DOM.

---
_Source: https://npm.io/package/react-lazily-render · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
