react-height

WebJar for react-height

License

License

MIT
Categories

Categories

React User Interface Web Frameworks
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

react-height
Last Version

Last Version

2.2.1
Release Date

Release Date

Type

Type

jar
Description

Description

react-height
WebJar for react-height
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/nkbt/react-height

Download react-height

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/react-height/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>react-height</artifactId>
    <version>2.2.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/react-height/
implementation 'org.webjars.npm:react-height:2.2.1'
// https://jarcasting.com/artifacts/org.webjars.npm/react-height/
implementation ("org.webjars.npm:react-height:2.2.1")
'org.webjars.npm:react-height:jar:2.2.1'
<dependency org="org.webjars.npm" name="react-height" rev="2.2.1">
  <artifact name="react-height" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='react-height', version='2.2.1')
)
libraryDependencies += "org.webjars.npm" % "react-height" % "2.2.1"
[org.webjars.npm/react-height "2.2.1"]

Dependencies

compile (2)

Group / Artifact Type Version
org.webjars.npm : create-react-class jar 15.5.2
org.webjars.npm : prop-types jar 15.5.8

Project Modules

There are no modules declared in this project.

react-height npm

CircleCI Dependencies Dev Dependencies

Component-wrapper to determine and report children elements height

React Height

Goals

  • react-height keeps things simple, therefore it does not support nested height change, it only checks immediate children change
  • not based on specific browser APIs, so can be used in other environments too

React Height

Demo

https://nkbt.github.io/react-height

Codepen demo

https://codepen.io/nkbt/pen/NGzgGb

Installation

NPM

npm install --save react-height

yarn

yarn add react-height 

1998 Script Tag:

<script src="https://unpkg.com/react/umd/react.production.min.js"></script>
<script src="https://unpkg.com/react-height/build/react-height.js"></script>
(Module exposed as `ReactHeight`)

Usage

import {ReactHeight} from 'react-height';

<ReactHeight onHeightReady={height => console.log(height)}>
  <div>Random content</div>
</ReactHeight>

Options

onHeightReady: PropTypes.func.isRequired

Callback, invoked when height is measured (and when it is changed).

getElementHeight: PropTypes.func

Function to measure your element. It receives the element as argument and defaults to el => el.clientHeight.

children: PropTypes.node.isRequired

One or multiple children with static, variable or dynamic height.

<ReactHeight onHeightReady={height => console.log(height)}>
  <p>Paragraph of text</p>
  <p>Another paragraph is also OK</p>
  <p>Images and any other content are ok too</p>
  <img src="nyancat.gif" />
</ReactHeight>

hidden: PropTypes.bool (default: false)

ReactHeight can render to null as soon as height is measured.

<ReactHeight hidden={true} onHeightReady={height => console.log(height)}>
  <div>Will be removed from the DOM when height is measured</div>
</ReactHeight>

Pass-through props

All other props are applied to a container that is being measured. So it is possible to pass style or className, for example.

<ReactHeight onHeightReady={height => console.log(height)}
  style={{width: 200, border: '1px solid red'}}
  className="myComponent">

  <div>
    Wrapper around this element will have red border, 200px width
    and `class="myComponent"`
  </div>
</ReactHeight>

Development and testing

Currently is being developed and tested with the latest stable Node on OSX.

To run example covering all ReactHeight features, use yarn start, which will compile example/index.js

git clone [email protected]:nkbt/react-height.git
cd react-height
yarn install
yarn start

# then
open http://localhost:8080

Tests

# to run ESLint check
yarn lint

# to run tests
yarn test

License

MIT

Versions

Version
2.2.1
2.0.0
1.1.0