react-simple-resizer ·

An intuitive React component set for multi-column resizing. It is easy to use and it also can customize the behavior of resizing in a very simple way. Working on every modern browser which support flexible box layout.

Table of Contents

• Installation
• Examples
• Components
  • Container
  • Section
  • Bar
• Customize resize behavior
• Demos
• Contributing

Installation

Using yarn:

yarn add react-simple-resizer

Or via npm:

npm install react-simple-resizer

Examples

We have create several demos on CodeSandbox, check the Demos to see more. Here is the minimal example for two column layout:

import React from 'react';
import { Container, Section, Bar } from 'react-simple-resizer';

export default () => (
  <Container style={{ height: '500px' }}>
    <Section style={{ background: '#d3d3d3' }} minSize={100}/>
    <Bar size={10} style={{ background: '#888888', cursor: 'col-resize' }} />
    <Section style={{ background: '#d3d3d3' }} minSize={100} />
  </Container>
);

Components

<Container />

Literally, as the container of the other components.

Props

import { HTMLAttributes } from 'react';

interface ContainerProps extends HTMLAttributes<HTMLDivElement> {
  vertical?: boolean;
  onActivate?: () => void;
  beforeApplyResizer?: (resizer: Resizer) => void;
  afterResizing?: () => void;
}

vertical

Determine that whether using vertical layout or not, default is false.

onActivate

Triggered when any Bar activated. i.e, onMouseDown or onTouchStart.

beforeApplyResizer

Used to customize resize behavior. In this method, you don't need to call applyResizer to apply the resize result. Please note that you should not do any side effect on this method. If you want to do something after the resizing, see afterResizing below.

afterResizing

Triggered after a resizing section is completed. Which means that it will be triggered after the onMouseUp and onTouchEnd events. If you want to do something after each time the size of section has changed, using the onSizeChanged props on the Section instead.

Instance properties

import React from 'react';

class Container extends React.PureComponent<ContainerProps> {
    public getResizer(): Resizer
    public applyResizer(resizer: Resizer): void
}

getResizer

Used to get the newest Resizer. But any change won't apply unless you pass the Resizer to applyResizer.

applyResizer

Apply the passed Resizer to Container.

---

<Section />

Props

import { HTMLAttributes, RefObject } from 'react';

interface SectionProps extends HTMLAttributes<HTMLDivElement> {
  size?: number;
  defaultSize?: number;
  maxSize?: number;
  minSize?: number;
  disableResponsive?: boolean;
  onSizeChanged?: () => void;
  innerRef?: RefObject<HTMLDivElement>;
}

size

Used to set the Section's size. If size exists, Section will ignore the value of defaultSize, maxSize and minSize.

defaultSize

Used to set the default size of Section.

maxSize

Used to set the max size of Section.

minSize

Used to set the min size of Section.

disableResponsive

Each Section is responsive as default, unless size is exists. the responsive means that the Section's size is related with Container's size, if Container's size turn smaller, the Section's size also turn smaller automatically. Otherwise, the changes of Container size won't affect the Section that disableResponsive is true.

onSizeChanged

Will be triggered each time the size has changed.

innerRef

Used to get the actual DOM ref of Section.

---

<Bar />

Props

import { HTMLAttributes, RefObject } from 'react';

interface ExpandInteractiveArea {
  top?: number;
  left?: number;
  right?: number;
  bottom?: number;
}

interface BarProps extends HTMLAttributes<HTMLDivElement> {
  size: number;
  expandInteractiveArea?: ExpandInteractiveArea;
  onStatusChanged?: (isActive: boolean) => void;
  innerRef?: RefObject<HTMLDivElement>;
}

size

Required, used to set the size of the Bar.

expandInteractiveArea

Used to expanding the interactive area of the Bar.

onStatusChanged

Triggered when the state of the Bar has changed.

innerRef

Used to get the actual DOM ref of Bar.

Customize resize behavior

If you want to customize the behavior of resizing, then the Resizer is what you need to know.

There is two ways to get the Resizer. One is the method beforeApplyResizer defined on the props of Container, and the other is the method getResizer defined on the instance of Container

interface Resizer {
  resizeSection: (indexOfSection: number, config: { toSize: number; preferMoveLeftBar?: boolean }) => void;
  moveBar: (indexOfBar: number, config: { withOffset: number; }) => void;
  discard: () => void;
  isSectionResized: (indexOfSection: number) => boolean;
  isBarActivated: (indexOfBar: number) => boolean;
  getSectionSize: (indexOfSection: number) => number | -1;
  getTotalSize: () => number;
}

resizeSection

Used to set the size of the nth Section. In multi-column layout, there is not only one Bar could change the Section's size. Therefor, you could use preferMoveLeftBar to try to use the left side Bar to resizing.

moveBar

Used to move the nth Bar to resizing. If the value of A is negative, move Bar to the left. Once vertical is true, move up.

discard

Discard resizing at this time.

isSectionResized

Used to determine whether the nth Section's size is changed at current resizing section or not.

isBarActivated

Used to determine whether the nth Bar is active or not.

getSectionSize

Used to get the size of the nth Section. if there is no nth Section, return -1.

getTotalSize

Used to get the total size of the Section.

Demos

• Simple demo
• Make Section collapsible
• Multiple Section linkage effects

Contributing

The main purpose of this repository is to continue to evolve react-simple-resizer core, making it faster, smaller and easier to use. We are grateful to the community for contributing bugfixes and improvements.

About Demo

Feel free to let us know that you have create some new customized resize behavior. If you want, you could make a PR to let more people see your works. Also, if you find some behavior that you can not create, let us know too.