GitXplorerGitXplorer
t

react-bootstrap-combobox

public
7 stars
0 forks
1 issues

Commits

List of commits on branch master.
Unverified
aaf3f2749a192f79e0b4fda9cb0c5098ed1a36e5

Release v3.0.1

tthealjey committed 9 years ago
Unverified
20138185d7998ecc2849654be047af2b93f54321

[removed] handleResize

tthealjey committed 9 years ago
Unverified
0e84ec99ca7a619dc934f16b5c0a2ca9caa9c88b

Release v3.0.0

tthealjey committed 9 years ago
Unverified
c232c9f299b532a70ee940e0abef1d52158275a1

[changed] host docs on GitHub Pages

tthealjey committed 9 years ago
Unverified
9cdeb942173af11f7cf2ab8000bb1f3b0f138487

[fixed] updated React to v0.14.0

tthealjey committed 9 years ago
Unverified
b5aca18543d76b739a22304550bcde6dcbac1434

[fixed] git ignore .idea

tthealjey committed 9 years ago

README

The README file for this repository.

react-bootstrap-combobox

A combo-box component for React Bootstrap.

Project Home | API Docs

Build Status Coverage Status Code Climate Dependency Status devDependency Status peerDependency Status npm version Slack channel

This is a very simple stateless wrapper around DropdownButton and MenuItem.

Features

  1. Minimizes the number of characters one would need to type when building a component in this fashion
  2. Provides a good looking dropdown component, built on Twitter Bootstrap, customizable with SASS, that works and looks the same in all major browsers
  3. The dropdown menu has a maximum height automatically calculated to prevent it from overflowing the viewport
  4. Provides a number of performance optimizations, both in JavaScript and CSS

Hint

Do not forget to set the NODE_ENV environment variable to "production" in production to get some instant performance increase from React for free!

Installation

npm i react-bootstrap-combobox --save

Usage

You need to include the "_index.scss" file from this package. If you are using webcompiler then you can simply do:

// import Bootstrap
@import "bootstrap";
// import Bootstrap theme
@import "bootstrap/theme";
// import the component
@import "react-bootstrap-combobox";

and then:

import {Combo} from 'react-bootstrap-combobox';

function someFunc(key: string) {
  ...
}

<Combo items={{
  // keys must be unique
  sweden: {label: 'Sweden', header: true}, // any combination of props supported by MenuItem
  volvo: 'Volvo',                          // same as {label: 'Volvo'}
  saab: 'Saab',
  separator: '-',                          // same as {divider: true}
  germany: {label: 'Germany', header: true},
  mercedes: 'Mercedes',
  audi: 'Audi'
}} value="volvo" onChange={someFunc} />

Caveats

  1. Both items and value are required props
  2. The component is stateless, which means that its value cannot be changed without re-rendering it
  3. For performance reasons items are considered immutable