❤
npm
Sign UpSign In

react-summary

1.0.5 • Public • Published

React-Summary

Summaries for react components.

Usage

import Summary from 'react-summary';
 
class App() {
  showOthers() {
  	// others
  }
 
  render() {
    return (
      <Summary items={['hey', 'foo', 'bar', 'selam']}
               max={2}
               onShowOthers={this.showOthers} />
    )
  }
}

Screenshot

Screenshot

Configuration

The Summary component expects the following props.

Parameter Default
items [] The collection that will be aggregated
max 3 Maximum visible item count
text Object. Explained on the following table. Translations of visible texts
preventSingleRemaining false Prints the last item instead of and 1 more text
onShowOthers No-op Callback function for show others link
itemRenderer Identity (returns given parameter) A wrapper function for styling items
block react-summary The className attribute of component

To styling items, you can provide react components in your collection instead of using itemRenderer.

Translation strings:

Parameter Default
more 'more'
and 'and'
none 'none'

Contributors (You can add your name here in your pull-request)

Readme

Keywords

Package Sidebar

Install

npm i react-summary

Repository

github.com/adphorus/react-summary

Homepage

github.com/adphorus/react-summary

Weekly Downloads

1

Version

1.0.5

License

MIT

Last publish

Collaborators

  • fatiherikli
Try on RunKit
Report malware