Skip to content

react-component/overflow

Repository files navigation

@rc-component/overflow

Ant Design Part of the Ant Design ecosystem.

📦 Auto-collapse React layout primitive for rendering visible items and overflow indicators.

NPM version npm downloads build status Codecov bundle size dumi

English | 简体中文

Highlights

Area Support
Purpose Auto-collapse React layout primitive for rendering visible items and overflow indicators.
Package @rc-component/overflow
Release @rc-component/np / rc-np

Install

npm install @rc-component/overflow

Usage

import Overflow from '@rc-component/overflow';

export default () => (
  <Overflow
    data={[1, 2, 3]}
    renderItem={item => <span>{item}</span>}
    renderRest={items => <span>+{items.length}</span>}
  />
);

API

Prop Description
data Items rendered by Overflow.
renderItem Render a visible item.
renderRest Render collapsed overflow items.

Development

npm install
npm start
npm test
npm run lint
npm run tsc
npm run compile

The dumi site runs at http://localhost:8000.

Release

npm run prepublishOnly

The release flow is handled by @rc-component/np through the rc-np command when the package uses the shared release flow.

License

@rc-component/overflow is released under the MIT license.

About

📦 Auto collapse box util component

Resources

License

Stars

64 stars

Watchers

6 watching

Forks

Packages

 
 
 

Contributors

Generated from react-component/footer