Connor Chase edited this page Aug 13, 2017 · 22 revisions

Welcome to the react-bootstrap wiki!

These wiki pages are primarily intended to aid in documenting patterns and practices used in developing this library. User documentation can be found at http://react-bootstrap.github.io/

1.0.0 Roadmap

While @stevoland and @pieterv have done an amazing job at getting this project started, we have a lot of work to do to declare this library ready for a 1.0.0 release. As mentioned in the Maintaining - Releases documentation, we will do everything in our power to ensure that semver guidelines are followed. Currently, the question stands, when is the best time we can confidently release 1.0.0. The following guidelines should be considered to make such a declaration.

  • Favicon - Short but important for branding, add the RB logo as favicon for docs site.

  • Consistent API - From component to component we should ensure that similar concepts are implemented in a clear and intuitive manner.

    • onClick handlers - function signature function(event, [eventKey])

      • On anchors, we don't call e.preventDefault() that should be left to the consumer.
    • onSelect handlers - Ongoing conversation #419

    • Correct English on Components name (Collapsable => Collapsible) #425

    • Figure out either a naming scheme or another method for applying classNames for nested elements within a component. See #560 and #517

  • styleMap - Trevor Robinson did fantastic work on improvements, but, unfortunately, it is still being used blindly by many components. One issue with this is some components are failing to apply classes. For example, a Button component does not currently have CSS defined for tabs or pills, which this implementation should allow. Further investigation is still needed to find a proper solution.

  • Simple Components - #56

  • Accessibility - Each component needs to be thoroughly investigated to ensure Web Accessibility standards are being incorporated. There's a great piece of documentation by WebAim, which is a non-profit organization and an advocate for Web Accessibility standards and implementation. The Web Accessibility standards are an important element for organizations who must meet strict guidelines required by law in both the United States and Internationally. It's important to note that seeking after these standards and implementations will not only benefit those with disabilities, but every user. For example, keyboard functionality with each of these components can be used by most people regardless of any handicaps.

    • Accordion
    • Affix
    • Alert
    • Badge
    • Breadcrumb
    • Button
    • ButtonGroup
    • ButtonToolbar
    • CollapsableNav
    • Carousel
    • CarouselItem
    • Col
    • DropdownButton
    • DropdownMenu
    • Glyphicon
    • Grid
    • Icon
    • Input
    • Interpolate
    • Jumbotron
    • Label
    • ListGroup
    • ListGroupItem
    • Media
    • MenuItem
    • Modal. #612 Focus on modal dialogs.
    • Modal. #723 When a Modal is open keep focus on the Modal.
    • Nav
    • Navbar
    • NavItem
    • ModalTrigger
    • OverlayTrigger
    • Pagination
    • PageHeader
    • Panel
    • PanelGroup
    • PageItem
    • Pager
    • Popover
    • ProgressBar
    • Row
    • SplitButton
    • SubNav
    • TabbedArea
    • Table
    • TabPane
    • Thumbnail
    • Tooltip
    • Well
  • Documentation The documentation is good in whole, but still lacks.
    The first thing to do is add an introduction page to the project. Splitting the documentation similar to Bootstrap's site would help people navigate around the web page. Also, the documentation for each component needs to be updated. Every prop we pass needs to be documented/exemplified as well.

    • Code Highlighting everywhere #94

    • #149 Add an introduction page

    • Prop documentation #716

    • Split the documentation the same way Bootstrap does

    • Update per-component documentation

      • Accordion
      • Affix
      • Alert
      • Badge
      • Breadcrumb
      • Button
      • ButtonGroup
      • ButtonToolbar
      • CollapsableNav
      • Carousel
      • CarouselItem
      • Col
      • DropdownButton
      • DropdownMenu
      • Glyphicon
      • Grid
      • Icon
      • Input
      • Interpolate
      • Jumbotron
      • Label
      • ListGroup
      • ListGroupItem
      • Media
      • MenuItem
      • Modal
      • Nav
      • Navbar
      • NavItem
      • ModalTrigger
      • OverlayTrigger
      • Pagination
      • PageHeader
      • Panel
      • PanelGroup
      • PageItem
      • Pager
      • Popover
      • ProgressBar
      • Row
      • SplitButton
      • SubNav
      • TabbedArea
      • Table
      • TabPane
      • Thumbnail
      • Tooltip
      • Well
    • The list of needs better docs issues

  • Do not forget to remove warning about pre-1.0.0 API changes from Start page.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.