@hitchcott/semantic-ui-react

<img height="128" width="128" src="https://cloud.githubusercontent.com/assets/5067638/17415622/7ac62496-5a3f-11e6-864e-217ad1d9e021.png">

The official <a href="http://semantic-ui.com">Semantic UI</a>
+
<a href="https://facebook.github.io/react">React</a>
integration.

Hey, we're in development. Prior to reaching v1.0.06:

1. MINOR versions represent breaking changes
2. PATCH versions represent fixes and features
3. There are no deprecation warnings between releases
4. You should consult the CHANGELOG18 and related issues/PRs for more information

Voice Your Opinion19 :speechballoon:

Help shape this library by weighing in on our RFC (request for comments)19 issues.

How Can I Help? :hand:

Documentation2 :bluebook:

Getting started

• Installation & Usage
• Debugger
• How Can I Help?

- Good First Contribution21 - Missing Components17 - Help Wanted Label4

• Our Principles
• Support
• Releasing
• Credit

Installation & Usage

See the Documentation2 for an introduction, usage information, and extensive examples.

Debugger

We use the debug module for debugging. You can turn debugging on and off via the localStorage.debug flag from the browser console. See the debug docs for more.

localStorage.debug = 'semanticUIReact:*'         // default, debug all components
localStorage.debug = 'semanticUIReact:dropdown'  // debug only the dropdown
localStorage.debug = null                        // turn debug off

Once you change the flag, you need to refresh your browser to see the changes in debug output.

How Can I Help?

Our CONTRIBUTING.md1 is a step-by-step setup and development guide. It is meant to be read from top to bottom. Once you're up to speed, each issue here includes more information on how you can help:

Good First Contribution21

Issues labeled good first contribution21 are a great way to ease into development on this project.

Missing Components17

We're seeking component parity with Semantic UI, plus some addons. There is an issue for every missing component, labeled enhancement help wanted17. Just comment on the issue you'd like to take.

Help Wanted Label4

Any other issue labeled help wanted4 is ready for a PR.

Our Principles

TechnologyAdvice9 has been dogfooding10 Semantic-UI-React in production since fall of 2015. These are the guiding principles that have developed as a result:

• No jQuery dependency
• No animation dependencies
• Reuse SUI CSS transitions
• Simple declarative component APIs vs intricate HTML markup
• Complete keyboard support
• Complete SUI component definition support
• Completely documented
• Completely tested

Support

| Elements | Collections | Views | Modules | Behaviors | |-----------------|-----------------|-----------------|-----------------|--------------------| | ✓ Button | ✓ Breadcrumb | Advertisement | ✓ Accordion | Form Validation | | ✓ Container | ✓ Form | ✓ Card | ✓ Checkbox | API (NA) | | ✓ Divider | ✓ Grid | ✓ Comment | ✓ Dimmer | Visibility (NA) | | ✓ Flag | ✓ Menu | ✓ Feed | ✓ Dropdown | | | ✓ Header | ✓ Message | ✓ Item | ✓ Embed | | | ✓ Icon | ✓ Table | ✓ Statistic | ✓ Modal | | | ✓ Image | | | Nag | | | ✓ Input | | | ✓ Popup | | | ✓ Label | | | ✓ Progress | | | ✓ List | | | ✓ Rating | | | ✓ Loader | | | ✓ Search | | | ✓ Rail | | | Shape | | | ✓ Reveal | | | Sidebar | | | ✓ Segment | | | Sticky | | | ✓ Step | | | Tab | | | | | | Transition | |

Releasing

On the latest clean master:

npm run release:major
npm run release:minor
npm run release:patch

Credit

Made with :heart: @TechnologyAdvice9, a ridiculous place to work16.
Big thanks to our contributors20, especially:

• @jamiehill for early engineering and support
• @jcarbo for thoughtful engineering and continual support
• @layershifter for bringing momentum and continual support