Integration of Semantic UI with UXPin Merge Technology. Check out Merge Wiki for detailed documentation
Semantic UI is a UI component framework for theming websites. Semantic UI enables developers to build websites with fast and concise HTML, along with a complete mobile responsive experience.
Merge is a revolutionary technology that lets users import (and keep in sync) coded React.js components from GIT repositories to UXPin editor. The imported components are 100% identical to components used by developers during the development process. It means that components are going to look and, function (interactions, data) identical to the real product experienced by the users.
UXPin is a leading code–based design platform.
Merge is currently only available for selected beta users.
- Fork this repository and clone it to your computer.
- Install dependencies with
npm install - Log in to your UXPin beta account (approved for alpha and beta tests by UXPin Inc.)
- Start Merge dev environment with
npm run uxpin:experiment
If you wish to push Semantic UI components to your UXPin account – check guide to integration with CI servers in our WIKI
| Elements | Status |
|---|---|
| Button | ✅ Full Support |
| Container | ✅ Full Support |
| Divider | ✅ Full Support |
| Flag | ✅ Full Support |
| Header | ✅ Full Support |
| Icon | ✅ Full Support |
| Image | ✅ Full Support |
| Input | ✅ Full Support |
| Label | ✅ Full Support |
| List | 🐛 Doesn't render children from preset. |
| Loader | ✅ Full Support |
| Placeholder | ✅ Full Support |
| Label | ✅ Full Support |
| Rail | 🔻 Not Supported. |
| Reveal | ✅ Full Support |
| Segment | ✅ Full Support |
| Step | ✅ Full Support |
| Collections | Status |
|---|---|
| Breadcrumb | ✅ Full Support |
| Form | 🔻 Not Supported. Unknown issues. |
| Grid | 🔻 Not Supported. |
| Menu | ✅ Full Support |
| Message | ✅ Full Support |
| Table | ✅ Full Support |
| Modules | Status |
|---|---|
| Accordion | 🐛 No possibility to edit contect yet. |
| Checkbox | ✅ Full Support |
| Dimmer | 🔻 Not Supported. |
| Dropdopwn | 🔻 Not Supported yet. |
| Embed | ✅ Full Support |
| Modal | 🐛 No possibility to open modal yet. |
| Popup | ✅ Full Support |
| Progress | ✅ Full Support |
| Rating | ✅ Full Support |
| Search | ✅ Full Support |
| Sidebar | ✅ Full Support |
| Sticky | 🔻 Not Supported. |
| Tab | ✅ Full Support |
| Transition | 🔻 Not Supported yet. |
| Views | Status |
|---|---|
| Advertisement | ✅ Full Support |
| Card | ✅ Full Support |
| Comment | ✅ Full Support |
| Feed | ✅ Full Support |
| Item | ✅ Full Support |
| Statistic | ✅ Full Support |
The recommended approach to integrating React.js components with UXPin is via Continues Integration server (Circle CI, Travis...). This approach provides an opportunity to establish a real single source of truth for design and development.
After the integration with a CI server every commit to master can (if this is how your CI is configured) automatically update library in UXPin.
This repository consits of an example of integration with Circle CI. If you wish to reuse it follow these steps:
- Make sure that you forked this repository.
- Go to https://circleci.com and sign-up for an account with your Github credentials.
- Start a new project and track your fork of this repository.
- Go into your UXPin account, enter UXPin editor (in any project).
- While inside of UXPin editor open Design Systems Libraries panel and create a new library. Copy the library token (keep it secure it provides access to your library!)
If you're not seeing the screen above – contact your account manager. You're not in Merge Beta group yet.
- Go into settings of your project in Circle CI. Enter section
Environment Variablesand click onAdd new variable. - Name the new variable
UXPIN_AUTH_TOKENand pass your token copied from the UXPin library (#5) as its value.
That's it! The next change in the master branch of your fork will automatically trigger Circle CI and send the newest version of your components to UXPin.
Integration with CI server leads to a powerful workflow, with that however comes couple of dangers, so please be aware of them!
⚠️ Don't share your UXPin authorization token with anyone. It leads straight to your design system library in UXPin. Keep the token safe in the CI app!⚠️ Don't keep your UXPin authorization token in any file checked into your git repository.⚠️ Treat contributing to Master branch just like deploying production code. Any change will be automatically reflected in the UXPin library and projects. If you want to experiment with components – start a new branch and use Merge dev environment – experiment mode (in this repository launched vianpm start)
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 examples.
- 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...
- https://gitconnected.com
- 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
- add your site here
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
See our webpack 3 example project here (includes theming).
Advanced universal starter with Semantic-UI-React. React/Redux/Lazy-loading/SSR/PWA.
Semantic UI React implementation of react-redux Todo List.
Can I use custom Icons?
Yes. Just use<Icon className='my-icon' /> instead of `<Icon name='my-icon' />`. See Semantic-Org#931 (comment) 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:
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.
Issues labeled good first issue 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.
- No animation dependencies
- Simple declarative component APIs vs brittle HTML markup
- Complete keyboard support
- Complete SUI component definition support
- Completely documented
- Completely tested
- Accessible
Created by @levithomason and an amazing community of contributors.
Made possible only by @jlukic authoring Semantic UI.