⚠️NOTE: Currently Semantic UI React is not yet compatible with the latest 2.3 version of Semantic UI styles. See #2250 for more info.
Semantic UI React
Hey, we're in development. Prior to reaching v1.0.0:
- MINOR versions represent breaking changes
- PATCH versions represent fixes and features
- There are no deprecation warnings between releases
- 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.
Built With Semantic UI React
These great products are built on Semantic UI React. Add yours here.
- Netflix's Edge Developer Experience team's numerous internal apps
- Amazon Publishing — the full-service publisher of Amazon — APub.com
- Microsoft's Teams prototyping
- https://gitconnected.com - The community for developers and software engineers
- http://stoplight.io
- https://roadmap.space
- https://edabit.com
- https://blackship.com
- http://www.brewhousesolutions.com
- https://www.seeuletter.com
- https://www.stackforge.co
- https://sublimefund.org
- https://thefaithcircle.com
- https://appfollow.io
- http://according.to.localsourc.es
- http://www.aircip.ir
- https://www.bailfacile.fr
- http://platform.nazarbazaar.ir
- https://build.games
- https://platform.forecastcycles.com
- https://www.findlectures.com
- https://github.com/ayastreb/bandwidth-hero
- https://re.yomeshgupta.com
- https://moneytracker.cc
- https://tax.cryptact.com
- https://www.hurriyetoto.com
- https://173app.com
- https://disten.se
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.
webpack
Our example project right here in this repo. Includes theming examples.
SUIcrux
Advanced universal starter with Semantic-UI-React. React/Redux/Lazy-loading/SSR/PWA.
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:
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 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.
100% Semantic UI Support
| Elements | Collections | Views | Modules | Behaviors |
|---|---|---|---|---|
| ✓ Button | ✓ Breadcrumb | ✓ Advertisement | ✓ Accordion | Form Validation |
| ✓ Container | ✓ Form | ✓ Card | ✓ Checkbox | API (NA) |
| ✓ Divider | ✓ Grid | ✓ Comment | ✓ Dimmer | ✓ Visibility |
| ✓ 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 |
Principles
- 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:
yarn release:majoryarn release:minoryarn release:patchReleasing will update the changelog which requires github_changelog_generator.
Credit
Originally made for @TechnologyAdvice by @levithomason.
Big thanks to our contributors, especially:
- @layershifter for essentially taking over during @levithomason's unavailability
- @jcarbo for thoughtful engineering
- @jamiehill for early engineering and support