JavaScript
Clone or download
Permalink
Failed to load latest commit information.
.circleci chore(CI): use prebuilt image (#2833) May 25, 2018
.github refactor(docs): normalize dir naming and casing (#2863) Jun 1, 2018
build chore(package): use Babel 7 (#2750) May 1, 2018
docs chore(package): add `sideEffects: false` for Webpack 4 (#2941) Jun 23, 2018
examples fix(examples): webpack 3 App direct import description (#2929) Jun 21, 2018
gulp docs(assets): move images to /public (#2935) Jun 22, 2018
src chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018
test chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018
.babelrc refactor(_meta): replace with build time JSON (#2840) May 31, 2018
.editorconfig Add Circle CI badge to README Dec 20, 2015
.eslintignore refactor(docs): normalize dir naming and casing (#2863) Jun 1, 2018
.eslintrc chore(package): use keyboard-key package (#2707) Apr 30, 2018
.gitignore refactor(docs): normalize dir naming and casing (#2863) Jun 1, 2018
.prettierignore refactor(docs): normalize dir naming and casing (#2863) Jun 1, 2018
.prettierrc.json chore(package): use Babel 7 (#2750) May 1, 2018
CHANGELOG.md docs(changelog): update changelog [ci skip] Jun 4, 2018
LICENSE.md chore(LICENSE): add MIT license Aug 16, 2016
README.md docs(assets): move images to /public (#2935) Jun 22, 2018
codecov.yml chore(coverage): remove docs from coverage reports (#1283) Feb 5, 2017
config.js docs(assets): move images to /public (#2935) Jun 22, 2018
gulpfile.babel.js refactor(_meta): replace with build time JSON (#2840) May 31, 2018
index.d.ts chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018
karma.conf.babel.js docs(assets): move images to /public (#2935) Jun 22, 2018
package.json chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018
tsconfig.json test(typings): add rendering test (#1625) May 6, 2017
tslint.json chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018
webpack.config.babel.js chore(package): upgrade to react-hot-loader 4 (#2783) May 11, 2018
webpack.dll.js chore(package): update all dependencies (#1895) Aug 20, 2017
webpack.umd.config.js chore(package): update all dependencies (#1895) Aug 20, 2017
yarn.lock chore(typings): update TypeScript and use tslint-config-airbnb (#2942) Jun 23, 2018

README.md

Semantic UI React

Gitter Circle Codecov David 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 examples.

Built With

  • Amazon Publishing — the full-service publisher of Amazon — APub.com
  • Netflix's Edge Developer Experience team's numerous internal apps
  • Netflix's flamescope
  • Microsoft's Teams prototyping
And many more...

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.

Show projects

webpack

See our webpack 3 example project here (includes theming).

SUIcrux

Advanced universal starter with Semantic-UI-React. React/Redux/Lazy-loading/SSR/PWA.

semantic-ui-react-todos

Semantic UI React implementation of react-redux Todo List.

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][23].
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:

How Can I Help?

Voice Your Opinion

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

Contribute

Our CONTRIBUTING.md is a step-by-step setup and development guide.

Good First Issue

Issues labeled good first issue 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.

Principles

  • No animation dependencies
  • Simple declarative component APIs vs brittle HTML markup
  • Complete keyboard support
  • Complete SUI component definition support
  • Completely documented
  • Completely tested
  • Accessible

Credit

Created by @levithomason and an amazing community of contributors.

Made possible only by @jlukic authoring Semantic UI.