The official Semantic-UI-React integration
JavaScript HTML
Permalink
Failed to load latest commit information.
.github docs(CONTRIBUTING): update toc Jan 13, 2017
browser refactor(project): stardust => semantic-ui-react (#608) Oct 3, 2016
docs docs(ComponentProps): show func signatures (#1194) Jan 20, 2017
gulp chore(build): simplify and fix hmr (#821) Nov 10, 2016
src feat(Table): add `sortable` and `sorted` props (#1109) Jan 20, 2017
test feat(Table): add `sortable` and `sorted` props (#1109) Jan 20, 2017
.babelrc perf(props): Remove propTypes from production build (#731) Jan 13, 2017
.editorconfig Add Circle CI badge to README Dec 20, 2015
.eslintignore Remove console.group* usage (#273) Jun 23, 2016
.eslintrc fix(docs): importing `../common` on doc site can be edited (#1078) Dec 22, 2016
.gitignore Button: update to v1 API (#295) Sep 9, 2016
CHANGELOG.md docs(changelog): update changelog [ci skip] Jan 20, 2017
LICENSE.md chore(LICENSE): add MIT license Aug 16, 2016
README.md docs(readme): remove extra row in support table Dec 30, 2016
circle.yml chore(package): Add ts-lint for typings (#1156) Jan 17, 2017
codecov.yml feat(factories): add shorthand factory (#529) Sep 23, 2016
config.js fix(docs): use rawgit production CDN Nov 3, 2016
gulpfile.js chore(build): simplify and fix hmr (#821) Nov 10, 2016
index.d.ts feat(typings): add Popup, Embed, Reveal and other updates (#1136) Jan 9, 2017
karma.conf.js chore(karma): do not exit on resource errors Oct 31, 2016
package.json 0.64.3 Jan 20, 2017
tslint.json chore(package): Add ts-lint for typings (#1156) Jan 17, 2017
webpack.config.js test(Examples): assert no console errors (#645) Dec 16, 2016
webpack.dll.js refactor(build): flatten /config and /build (#385) Aug 9, 2016
webpack.umd.config.js perf(docs): improve doc bundle and load experience (#865) Nov 16, 2016

README.md

The official Semantic UI + React integration.

Semantic-UI-React (Stardust)

Gitter Circle CI Codecov Gemnasium npm

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

  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 CHANGELOG and related issues/PRs for more information

Voice Your Opinion πŸ’¬

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

How Can I Help? βœ‹

Documentation πŸ“˜

Getting started

Installation & Usage

See the Documentation 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.md 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 Contribution

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

Missing Components

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

Help Wanted Label

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

Our Principles

TechnologyAdvice has been dogfooding 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 βœ“ Popup
βœ“ Input βœ“ Progress
βœ“ Label βœ“ Rating
βœ“ List βœ“ Search
βœ“ Loader Shape
βœ“ Rail βœ“ Sidebar
βœ“ Reveal Sticky
βœ“ Segment Tab
βœ“ Step Transition

Releasing

On the latest clean master:

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

Credit

Made with ❀️ @TechnologyAdvice, a ridiculous place to work.

Big thanks to our contributors, especially:

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