Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

README.md 10 KiB

il y a 3 ans
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. [![reactstrap](https://cloud.githubusercontent.com/assets/399776/13906899/1de62f0c-ee9f-11e5-95c0-c515fee8e918.png)](https://reactstrap.github.io)
  2. [![CDNJS](https://img.shields.io/cdnjs/v/reactstrap.svg)](https://cdnjs.com/libraries/reactstrap) [![NPM Version](https://img.shields.io/npm/v/reactstrap.svg?branch=master)](https://www.npmjs.com/package/reactstrap) [![Build Status](https://travis-ci.org/reactstrap/reactstrap.svg?branch=master)](https://travis-ci.org/reactstrap/reactstrap) [![Coverage Status](https://coveralls.io/repos/github/reactstrap/reactstrap/badge.svg?branch=master)](https://coveralls.io/github/reactstrap/reactstrap?branch=master) [![License](https://img.shields.io/npm/l/reactstrap.svg)](https://github.com/reactstrap/reactstrap/blob/master/LICENSE)
  3. # reactstrap
  4. Stateless React Components for Bootstrap 4.
  5. ## Getting Started
  6. Follow the [create-react-app instructions](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) **up to** the `Adding Bootstrap` section and instead follow the reactstrap version of [adding bootstrap](#adding-bootstrap).
  7. ### tl;dr
  8. ```
  9. npx create-react-app my-app
  10. cd my-app/
  11. npm start
  12. ```
  13. or, if npx (Node >= 6 and npm >= 5.2 ) not available
  14. ```
  15. npm install -g create-react-app
  16. create-react-app my-app
  17. cd my-app/
  18. npm start
  19. ```
  20. Then open [http://localhost:3000/](http://localhost:3000/) to see your app. The initial structure of your app is setup. Next, let's [add reactstrap and bootstrap](#adding-bootstrap).
  21. ### Adding Bootstrap
  22. Install reactstrap and Bootstrap from NPM. Reactstrap does not include Bootstrap CSS so this needs to be installed as well:
  23. ```
  24. npm install --save bootstrap
  25. npm install --save reactstrap react react-dom
  26. ```
  27. Import Bootstrap CSS in the ```src/index.js``` file:
  28. ```js
  29. import 'bootstrap/dist/css/bootstrap.css';
  30. ```
  31. Import required reactstrap components within ```src/App.js``` file or your custom component files:
  32. ```js
  33. import { Button } from 'reactstrap';
  34. ```
  35. Now you are ready to use the imported reactstrap components within your component hierarchy defined in the render
  36. method. Here is an example [`App.js`](https://gist.github.com/Thomas-Smyth/006fd507a7295f17a8473451938f9935) redone
  37. using reactstrap.
  38. ### Dependencies
  39. ##### Required Peer Dependencies
  40. These libraries are not bundled with Reactstrap and required at runtime:
  41. * [**react**](https://www.npmjs.com/package/react)
  42. * [**react-dom**](https://www.npmjs.com/package/react-dom)
  43. ##### Optional Dependencies
  44. These libraries are not included in the main distribution file `reactstrap.min.js` and need to be manually
  45. included when using components that require transitions or popover effects (e.g. Tooltip, Modal, etc).
  46. * [**react-transition-group**](https://www.npmjs.com/package/react-transition-group)
  47. * [**react-popper**](https://www.npmjs.com/package/react-popper)
  48. ### CDN
  49. If you prefer to include Reactstrap globally by marking `reactstrap` as external in your application, the
  50. `reactstrap` library provides various single-file distributions, which are hosted on the following CDNs:
  51. * [**cdnjs**](https://cdnjs.com/libraries/reactstrap)
  52. ```html
  53. <!-- Main version -->
  54. <script src="https://cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.min.js"></script>
  55. <!-- All optional dependencies version -->
  56. <script src="https://cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.full.min.js"></script>
  57. ```
  58. * [**unpkg**](https://unpkg.com/reactstrap/)
  59. ```html
  60. <!-- Main version -->
  61. <script src="https://unpkg.com/reactstrap@6.0.1/dist/reactstrap.min.js"></script>
  62. <!-- All optional dependencies version -->
  63. <script src="https://unpkg.com/reactstrap@6.0.1/dist/reactstrap.full.min.js"></script>
  64. ```
  65. > **Note**: To load a specific version of Reactstrap replace `6.0.1` with the version number.
  66. #### Versions
  67. Reactstrap has two primary distribution versions:
  68. 1) `reactstrap.min.js`
  69. This file **excludes** the optional dependencies – `react-popper` and `react-transition-group`.
  70. This is the recommended approach (similar approach in Bootstrap's JavaScript components) for including
  71. Reactstrap as it reduces the filesize and gives more flexibility in configuring needed dependencies.
  72. **Recommended use cases:**
  73. * Small, medium, or large applications
  74. * Applications that do not use any transitions or popper components
  75. * Applications that directly use `react-popper` or `react-transition-group` – Reactstrap and your application
  76. will use the single global version included
  77. 2) `reactstrap.full.min.js`
  78. This file **includes** the optional dependencies – `react-popper` and `react-transition-group`
  79. **Recommended use cases:**
  80. * Small applications
  81. #### Example
  82. ```html
  83. <!doctype html>
  84. <html lang="en">
  85. <head>
  86. <!-- Required dependencies -->
  87. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/prop-types/15.6.1/prop-types.min.js"></script>
  88. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react/16.3.2/umd/react.production.min.js"></script>
  89. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-dom/16.3.2/umd/react-dom.production.min.js"></script>
  90. <!-- Optional dependencies -->
  91. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-transition-group/2.2.1/react-transition-group.min.js"></script>
  92. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js"></script>
  93. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/react-popper/0.10.4/umd/react-popper.min.js"></script>
  94. <!-- Reactstrap -->
  95. <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/reactstrap/6.0.1/reactstrap.min.js"></script>
  96. <!-- Lastly, include your app's bundle -->
  97. <script type="text/javascript" src="/assets/bundle.js"></script>
  98. </head>
  99. <body>
  100. <div id="my-app" />
  101. </body>
  102. </html>
  103. ```
  104. ## About the Project
  105. This library contains React Bootstrap 4 components that favor composition and control. The library does not depend on jQuery or Bootstrap javascript. However, [Poppers.js](https://popper.js.org/) via [react-popper](https://github.com/souporserious/react-popper) is relied upon for advanced positioning of content like Tooltips, Popovers, and auto-flipping Dropdowns.
  106. There are a few core concepts to understand in order to make the most out of this library.
  107. 1. Your content is expected to be composed via props.children rather than using named props to pass in Components.
  108. ```js
  109. // Content passed in via props
  110. const Example = (props) => {
  111. return (
  112. <p>This is a tooltip <TooltipTrigger tooltip={TooltipContent}>example</TooltipTrigger>!</p>
  113. );
  114. }
  115. // Content passed in as children (Preferred)
  116. const PreferredExample = (props) => {
  117. return (
  118. <p>
  119. This is a <a href="#" id="TooltipExample">tooltip</a> example.
  120. <Tooltip target="TooltipExample">
  121. <TooltipContent/>
  122. </Tooltip>
  123. </p>
  124. );
  125. }
  126. ```
  127. 2. Attributes in this library are used to pass in state, conveniently apply modifier classes, enable advanced functionality (like tether), or automatically include non-content based elements.
  128. Examples:
  129. - `isOpen` - current state for items like dropdown, popover, tooltip
  130. - `toggle` - callback for toggling `isOpen` in the controlling component
  131. - `color` - applies color classes, ex: `<Button color="danger"/>`
  132. - `size` - for controlling size classes. ex: `<Button size="sm"/>`
  133. - `tag` - customize component output by passing in an element name or Component
  134. - boolean based props (attributes) when possible for alternative style classes or `sr-only` content
  135. ## [Documentation](https://reactstrap.github.io)
  136. https://reactstrap.github.io
  137. Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/).
  138. ## [Contributing](CONTRIBUTING.md)
  139. ## Development
  140. Install dependencies:
  141. ```sh
  142. npm install
  143. ```
  144. Run examples at [http://localhost:8080/](http://localhost:8080/) with webpack dev server:
  145. ```sh
  146. npm start
  147. ```
  148. Run tests & coverage report:
  149. ```sh
  150. npm test
  151. ```
  152. Watch tests:
  153. ```sh
  154. npm run test-watch
  155. ```
  156. ## Releasing
  157. #### Create Release Branch
  158. Note: you must have the `GITHUB_TOKEN` environment variable set to a valid GitHub token with write access to your repo.
  159. To create a release branch and changelog, run the following command, optionally with a semantic release type (major, minor, patch) (if not provided, it will default to semver (it's best to let it default)):
  160. ```bash
  161. ./scripts/release <release-type>
  162. ```
  163. Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.
  164. #### Tagging and Publishing
  165. Note: you must have write permission to this repo do perform this action
  166. Once the release branch is merged, checkout master and run:
  167. ```bash
  168. ./scripts/publish
  169. ```
  170. This will build the current state of master, tag it based on the release version and push the tag up to GitHub. Travis will detect the new tag and publish to npm.
  171. _OR_
  172. You can create a new tag via the GitHub user interface. If you do it this way, make sure to use the correct version as the tag name (eg. `6.2.0`).
  173. ## In the wild
  174. Organizations and projects using `reactstrap`
  175. - [availity-reactstrap-validation](https://availity.github.io/availity-reactstrap-validation/)
  176. - [component-template](https://reactstrap.github.io/component-template/)
  177. - [video-react](https://video-react.github.io/)
  178. - [CoreUI-Free-Bootstrap-Admin-Template](https://github.com/mrholek/CoreUI-Free-Bootstrap-Admin-Template) - [demo](http://coreui.io/demo/React_Demo/#/)
  179. - [Admin dashboard example app built with reactstrap](https://github.com/reduction-admin/react-reduction) - [demo](https://reduction-admin.firebaseapp.com/)
  180. - [DevExtreme React Grid](https://devexpress.github.io/devextreme-reactive/react/grid/) - It's a stateless data grid built on top of `reactstrap` with paging, sorting, filtering, grouping, selection, editing and virtual scrolling features.
  181. - [DevExtreme React Chart](https://devexpress.github.io/devextreme-reactive/react/chart/) - A chart built on top of `reactstrap` that visualizes data using a variety of series types, including bar, line, area, scatter, pie, and more.
  182. Submit a PR to add to this list!
  183. Looking to build, document and publish reusable components built on top of `reactstrap`? Consider forking https://github.com/reactstrap/component-template to kickstart your project!