interval-resizer v3.5.2

Use this Component

About the Component

What is this for?

Interval-resizer is useful in a dashboard widget scenario, where you want your components to expand with their content, but you don't want a bunch of uneven heights. By setting your intervalUnit, you give the interval-resizer intervals to snap to, which means nice even heights among all your widget components, and a good end-user visual experience.

How does it work?

Whenever there is a change in the width of the window or a component update (triggered by prop changes or by any changes to the child wrapped in the interval-resizer), the interval-resizer will evaluate what the natural height of the internals. Then, the interval-resizer calculates the next interval to size to. This allows the internals to resize naturally, while still rounding to a clean interval height.

Why is it in TypeScript?

Don't worry, the npm package is in ES5 JavaScript! The source is written in TypeScript to generate a typings file just in case someone uses interval-resizer in a TypeScript project. Additionally some IDEs use typing in their corrective hinting, so it's just nice to have.

Use

Inside your component

See Props for explanation and use for each prop.

import React, { Component } from 'react';
import { IntervalResizer } from 'interval-resizer';

export default class App extends Component {
  // ...
  render() {
    return (
      <IntervalResizer
        intervalUnit={intervalUnit}
        minHeight={minHeight}
        maxHeight={maxHeight}
        className={className}
        screenWidthCutoff={screenWidthCutoff}
      >
        <div className="internals-wrapper">
          <div className="some-header">I'm a header</div>
          <div className="internals-content">
            {/* see 'Styling' below for more info */}
          </div>
          <div className="some-footer">I'm a footer</div>
        </div>
      </IntervalResizer>
    );
  }
}

Styling

In this section I will refer to the child components above by their className attributes. Naturally these can be anything and follow any structure, this is simply for ease of explaining.

Style the internals of this component however you'd style any div that resizes with its content. Note that the child (internals-wrapper) will snap to a height that is larger than its natural height, as it must reach an interval. As such, it is probably best if something inside is able to grow and fill the extra space. This can easily be done using flexbox and flex: 1 1 auto; on one of the internal children, for example internals-content. This is how it is done in the demo.

Keep in mind that the height attribute of the child (internals-wrapper) will be overwritten by the interval-resizer in order to switch between measuring the height and snapping to an interval, so it's best to not add a height property.

Props

Required

• intervalUnit
• children

Not Required

• minHeight
• maxHeight
• className
• screenWidthCutoff

Default: none - required Prop

Description:
Defines the interval in pixels to adjust height by when resizing.

Use:
This is the main feature of the component; it allows for your component to resize to a clean pixel height, at intervals defined using intervalUnit. A large value for intervalUnit means nice clean sizing, but the downside is lots of unused space within the component once it resizes to a larger height. Alternatively, a small value for intervalUnit will cause more accurate resizing, but less guarantee that your components will round to the same height.

Default: none - required Prop

Description:
The internal content wrapped by the IntervalResizer. Note that child must be a single element (it may wrap as many elements as you want). This can be passed as a JSX child rather than a prop as shown in the Inside your component section.

Use:
See Styling for a detailed explanation of how to structure the internals.

Default: 0 (not applied)

Description: The minimum height in pixels of the interval-resizer. If given, will not allow the component to become smaller than the provided height.

Use: For if you don't want your component to shrink beyond a certain height.

Default: -1 (not applied)

Description:
The maximum height in pixels of the interval-resizer. If given, will not allow the component to become larger than the provided height.

Use:
For if you don't want your component to grow beyond a certain height.

Default: undefined (no class)

Description:
A value for the class attribute on the component.

Use:
For applying styling to the component, as it has no inherent styling.

Default: 0 (not applied)

Description:
Defined the minimum width in pixels for interval resizing. Any browser window width below this amount will be resized normally with content (height: auto).

Use:
Used in tandem with styling breakpoints, this allows you to stop interval resizing below a certain screen width. The main use case is when you only have one column of dashboard widgets and you no longer need the heights to round off as the components fall one after another in a scrolling UI.