Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.32 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.32 KB

react-holder

forked from Ramesh Nair's react-image-holder.

A <Holder /> component for React which can render placeholders as provided by holder-js.

Important: holder-js generates its SVG's using DOM SVG features. For this reason react-dom is included as a dependency. You won't be able to use this for server-side rendering.

Install

npm install react-holder

## Usage

import Holder from 'react-holder'

export class Logo extends Component {
  render() {
    return (
      <div>
        <Holder
          // width and height can be a number or a string
          width="100%"
          height="200px"

          // default: false
          updateOnResize={true}

          // All holder-js options are supported here.
          // https://github.com/imsky/holder

          // Other props will be passed on to the generated <img /> tag
          className={'my-custom-class'}
        />
      </div>
    )
  }
}

Building

npm install
npm run build

Contributing

Contributions are welcome! Please see CONTRIBUTING.md.

License

MIT - see LICENSE.md