npm

react-component-lazy

1.3.3 • Public • Published

react-component-lazy

A lightweight libraries for lazyload your Components, Images or anything.

Main function

  • Lazyload your Components using IntersectionObserver
  • Loading components with dynamic imports
  • Lazyload your Components and loading components with dynamic imports once time
  • Creating a great "Loading..." Component
  • Creating a Error Alert

Lazyload your Components using IntersectionObserver

Load content that is visible on the screen.

import LazyComponent from 'react-component-lazy'
import Component from './Component'

export default class App extends React.Component {
  render() {
    return (
      <LazyComponent>
        <Component />
      <LazyComponent>
    )
  }
}

//or 
import {LazyComponent} from 'react-component-lazy'
const Component = LazyComponent(require('./Component'))

export default class App extends React.Component {
  render() {
    return (
      <Component />
    )
  }
}

Options

height Default height before Component loaded (default: 500)

return (
  <LazyComponent height="300">
    <Component />
  <LazyComponent>
)

//or 
const Component = LazyComponent(require('./Component'), {height: 300})

visible Is component first time visible

return (
  <LazyComponent visible={true}>
    <Component />
  <LazyComponent>
)
//or
const Component = LazyComponent(require('./Component'), {visible: true}

Loading components with dynamic imports

import {LazyImport} from 'react-component-lazy'
const Component = LazyImport(() => import('./Component'))

export default class App extends React.Component {
  render() {
    return (
      <Component />
    )
  }
}

Lazyload your Components and loading components with dynamic imports once time

import {LazyVisible} from 'react-component-lazy'
const Component = LazyVisible(() => import('./Component'))

export default class App extends React.Component {
  render() {
    return (
      <Component />
    )
  }
}

Options

height Default height before Component loaded (default: 500)

import {LazyVisible} from 'react-component-lazy'
const Component = LazyVisible(() => import('./Component'), {height: 300})

export default class App extends React.Component {
  render() {
    return (
      <Component />
    )
  }
}

retries Auto retry load component when error. (default: 3)

const Component = LazyVisible(() => import('./Component'), {retries: 5})

delay Delaytime for load component

const Component = LazyVisible(() => import('./Component'), {delay: 500})

Creating a great "Loading..." Component

You can customm default element, that is rendered before commponent loaded

import {LazyVisible} from 'react-component-lazy'
const Component = LazyVisible(() => import('./Component'), {
  height: 300,
  loadding(){
    return <div>Loading...</div>
  }
})

export default class App extends React.Component {
  render() {
    return (
      <Component />
    )
  }
}

Creating a Error Alert

You can customm Error Alert, that is rendered when component load failed

error(retry, error){
  return (
    <div className="load-failed">
      <p className="error">
        <i className="material-icons">warning</i>
        読み込みに失敗しました。もう一度お試しください。
      </p>
      <button className="btn btn-danger" onClick={retry}>リトライ</button>
    </div>
  )
}

Package Sidebar

Install

npm i react-component-lazy

Weekly Downloads

52

Version

1.3.3

License

MIT

Unpacked Size

28.1 kB

Total Files

9

Last publish

Collaborators

  • dinhduythanh