simple-react-bootstrap ---------------------- Simple and slim React bindings for those Bootstrap components which modify the DOM. Includes Modal, ButtonDropdown, and NavBar. These React components implement the Bootstrap widgets which require more than just css classes, namely `Modal`, `ButtonDropdown`, `NavBar` and `Tabs`. Installing ========== import with webpack via ```javasctipt import { Modal, NavBar, ButtonDropdown, Tabs, Tab } from 'simple-react-bootstrap' ``` As of version 0.3, this library ships standard ES6, which should run in all modern browsers. If you need to support older browsers, then just add the following alias to your webpack configuration ```javascript resolve: { extensions: [".ts", ".tsx", ".js"], alias: { "simple-react-bootstrap": "node_modules/simple-react-bootstrap/lib-es5/library.js" }, modules: [path.resolve("./"), path.resolve("./node_modules")] } ``` this will pull in transpiled, (and slightly larger) ES5, which should run fine in IE. Documentation ============= Tabs ==== Usage ----- ```javascript This is content a This is content b This is content c ``` This renders uncontrolled tabs with the first tab selected by default. To select a different tab by default, pass `defaultTab`, with the zero-based index (either string or number will work fine) of the relevant tab. ```javascript This is content a Selected by default This is content c ``` or you can give your tabs custom names ```javascript This is content a This is content b This is content c ``` Controlled ---------- Exactly the same as above, except pass in a `tab` property representing the current tab, and an `onChangeTab` method which will be invoked when a tab is selected, and passed the clicked tab's name. By default that will be the zero-based index, unless you override it with your own name, as shown above. ```jsx This is content a This is content b This is content c ``` Additional options ------------------ Any other props you pass to `` will be passed along to the corresponding tab header's `

`. ```jsx This is content a This is content b This is content c ``` If you'd like to pass props down to the corresponding tab-pane div, you can pass them all in a single `paneProps` prop ```jsx This is content a This is content b This is content c ``` Coming soon: tabs with dropdown headers, as shown here: [http://getbootstrap.com/javascript/#tabs](http://getbootstrap.com/javascript/#tabs) Modal ===== **NOTE** As of version 0.4, the Modal component uses css transitions to handle the animation. This greatly simplifies and reduces the library code, but does mean that you now need to load the stylesheet `simple-react-bootstrap-styles.css` into your application. This file is located at the root of this project, and loading it can be as simple as ```html ``` or of course you can use your favorite webpack loader. There's currently no way to turn animations off, but that may be added in a future release. Special thanks to [Brian Curley](https://twitter.com/ChasingTheB) for help with the css transitions. Usage ----- ```jsx this.setState({ basicModal: false })}>

Hello World

Modal body

``` The css class `fade` adds animation, as with Bootstrap normally. Everything else should work as expected. All props passed down to any of these sections should pass through properly. * * * NavBar ====== The NavBar component is mostly a set of helpers for generating the html Bootstrap expects. The real value this component adds is in the `NavBar.Dropdown`, and the `NavBar.Toggle` components; the latter adds the normal Bootstrap behavior which hides the NavBar's contents on small screens, and renders instead a "hamburger menu" button to slides toggle the contents down / up. Usage ----- ```jsx Header Link 1 Link 2 Link 3 Sub option a Sub option b Sub option c Sub option a Sub option b Sub option c Second Header

``` The `NavBar.Dropdown` component is implemented internally with the ButtonDropdown component (documented below). `ignoreContentClick` will be passed through as needed; also, manually controlling the dropdown's "open" state is just a matter of rendering the ButtonDropdown yourself, in controlled mode. For example ```jsx

Header Link 1 Link 2 Link 3 Sub menu

Sub option a

Sub option b

Sub option c

Sub option a Sub option b Sub option c Second Header

``` * * * ButtonDropdown ============== Basic dropdown-button --------------------- ```jsx

Hello

``` which will render ```jsx

``` The most simple use case passes two children to ButtonDropdown: the first will be rendered as given, but with a `dropdown-toggle` class added; the second will be rendered as given, but with a `dropdown-menu` class added. By default, both will be rendered in a div with the `btn-group` class added. When the `dropdown-toggle` element is clicked, the parent will have an `open` class added, which causes the dropdown content to show, per Bootstrap's css rules. Any click anywhere causes it to hide again. Fully customizable ------------------ Any properties you add to the root container, including styles, will be passed through; any css classes will be merged in with `btn-group`. Any click event added to the toggle button will be invoked prior to the default behavior of toggling the button (if you want to take over this toggling yourself, see below). Fully _fully_ customizable -------------------------- If you need a more robust dropdown button than can be represented with a toggleButton and a dropdown div, then pass whatever arbitrary children you want; just be sure to manually add the `dropdown-toggle` and `dropdown-menu` classes where needed, so the component will know what's what. ```jsx Arbitrary children + with null Hello {null} <---- toggle is right there

Hello

World

``` Using a custom component for the toggle button ---------------------------------------------- One caveat to the above, is that if you want to use a custom component for the toggle, such as ```jsx Tickets

Close Requests
Any
None
One
Two
More Than 2

``` Then two conditions must be satisfied: 1. The component cannot be a stateless functional component; in other words you need to define it with `class extends React.Component`. The reason boils down to refs, and `ReactDom.findDOMNode` not working with SFCs. 2. The component must pass through (or merge in) the onClick handler that's passed to it. Using a custom component for the dropdown content ------------------------------------------------- To use a custom component for the dropdown content, two conditions must be satisfied 1. The component cannot be a stateless functional component; in other words you need to define it with `class extends React.Component`. The reason boils down to refs, and `ReactDom.findDOMNode` not working with SFCs. 2. The component must pass through (or merge in) the classNames property, so the right css class makes it in. Misc options ------------ ##### clean Causes the `btn-group` class to not be added to the root container ##### disabled Disables the button, and prevents any toggling from happening ##### containerElementType Pass an element type to render for the root container, instead of a div. For example, pass the string `span` to render a span, etc. ##### deferDropdownRendering Pass `true` to defer rendering of the dropdown menu until it's actually open. Use this if you're rendering a lot of ButtonDropdowns, which all have some sort of expensive component in the dropdown. ##### ignoreContentClick By default any clicks in the dropdown menu will close the menu. This is usually desired, for example, a dropdown showing links should close after one of them is clicked. If you choose to use the dropdown for something else, and want clicks in the dropdown to _not_ cause the dropdown to close, pass `true` for this option. Controlled mode --------------- If you'd like to manually control the dropdown state, you can pass a value for `open` to the root container. You can then provide an `onToggle` callback that'll be called in all the places where the open/closed toggling would normally be done, when in un-controlled mode (ie, no `open` passed in). All the normal options are still respected. For example, this would essentially re-create the default dropdown behavior, while ignoring any clicks in the dropdown menu. ```jsx this.setState({ controlled1Open: !this.state.controlled1Open })} open={this.state.controlled1Open} >

``` A more flexible (if contrived) example follows. This causes the dropdown to only open if the toggle button is clicked, and once open, will only close if the close button in the dropdown menu is clicked. ```jsx

``` GitHub ------

React typeahead with Bootstrap styling

Simple and slim React bindings for those Bootstrap components which modify the DOM