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
See the Documentation for an introduction, usage information, and extensive examples.
This is a listing of example projects and guides that will help you integrate Semantic UI React into your new or existing projects.
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.
Yes. Just use <Icon className='my-icon' /> instead of <Icon name='my-icon' />. See Semantic-Org#931 (comment) for detailed info and examples.
There are several options. Refer to our doc on CSS Usage.
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:
These great products are built on Semantic UI React. Add yours here.
- http://stoplight.io
- https://roadmap.space
- https://edabit.com
- https://blackship.com
- http://www.brewhousesolutions.com
- https://www.lifebot.fr
Help shape this library by weighing in on our RFC (request for comments) issues.
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:
Issues labeled good first contribution are a great way to ease into development on this project.
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.
Any other issue labeled help wanted is ready for a PR.
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 offOnce you change the flag, you need to refresh your browser to see the changes in debug output.
| 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 |
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
On the latest clean master:
npm run release:major
npm run release:minor
npm run release:patchDeploy the docs:
npm run deploy:docsUpdate the changelog (requires github_changelog_generator):
github_changelog_generator
git add CHANGELOG.md
git commit -m 'docs(changelog): update changelog [ci skip]'
git pushMade 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