JavaScript HTML
Switch branches/tags
Permalink
Failed to load latest commit information.
.github chore(issue_template): simplify and update (#1532) Mar 30, 2017
browser refactor(project): stardust => semantic-ui-react (#608) Oct 3, 2016
build chore(package): support for jsnext:main (#1210) Jan 24, 2017
docs feat(Dropdown): add upward prop (#1603) Apr 21, 2017
examples/webpack1 feat(docs): use https url (#1598) Apr 18, 2017
gulp style(typings): fix import errors, remove dependency (#1460) Mar 14, 2017
src test(typings): initial tests for typings (#1611) Apr 24, 2017
test test(typings): initial tests for typings (#1611) Apr 24, 2017
.babelrc chore(coverage): remove docs from coverage reports (#1283) Feb 5, 2017
.editorconfig Add Circle CI badge to README Dec 20, 2015
.eslintignore Remove console.group* usage (#273) Jun 23, 2016
.eslintrc Update all dependencies 🌴 (#1418) Apr 3, 2017
.gitignore Button: update to v1 API (#295) Sep 9, 2016
CHANGELOG.md docs(changelog): update changelog [ci skip] Apr 24, 2017
LICENSE.md chore(LICENSE): add MIT license Aug 16, 2016
README.md Add StackForge to Built With section (#1607) Apr 22, 2017
circle.yml chore(package): Add ts-lint for typings (#1156) Jan 17, 2017
codecov.yml chore(coverage): remove docs from coverage reports (#1283) Feb 5, 2017
config.js chore(package): update to webpack 2 (#1502) Apr 2, 2017
gulpfile.js chore(build): simplify and fix hmr (#821) Nov 10, 2016
index.d.ts test(typings): initial tests for typings (#1611) Apr 24, 2017
karma.conf.js chore(package): update to webpack 2 (#1502) Apr 2, 2017
package.json 0.68.2 Apr 24, 2017
tslint.json chore(package): Add ts-lint for typings (#1156) Jan 17, 2017
webpack.config.js test(typings): initial tests for typings (#1611) Apr 24, 2017
webpack.dll.js chore(dll): remove dynamic hash type Apr 22, 2017
webpack.umd.config.js chore(package): update to webpack 2 (#1502) Apr 2, 2017

README.md

Semantic UI React

Gitter Circle 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

Installation & Usage

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

Example Projects

This is a listing of example projects and guides that will help you integrate Semantic UI React into your new or existing projects.

semantic-ui-react-todos

This example modifies the well-known react-redux Todo List to use Semantic UI components. There is also a write-up on the process in the project README.

FAQ

Can I use custom Icons?

Yes. Just use <Icon className='my-icon' /> instead of <Icon name='my-icon' />. See https://github.com/Semantic-Org/Semantic-UI-React/issues/931#issuecomment-263643210 for detailed info and examples.

How do I setup CSS?

There are several options. Refer to our doc on CSS Usage.

Can I use a custom CSS theme?

Yes. Semantic UI React includes components that render valid Semantic UI HTML, no CSS is included. This allows you to load any Semantic UI CSS theme on top of your Semantic UI React app.

Here are some helpful links:

Built With Semantic UI React

These great products are built on Semantic UI React. Add yours here.

Voice Your Opinion

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

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.

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.

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

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

Releasing

On the latest clean master:

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

Deploy the docs:

npm run deploy:docs

Update the changelog (requires github_changelog_generator):

github_changelog_generator
git add CHANGELOG.md
git commit -m 'docs(changelog): update changelog [ci skip]'
git push

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