Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Semantic-Org/Semantic-UI-React

The official Semantic-UI-React integration
https://github.com/Semantic-Org/Semantic-UI-React

component-library components frontend-components frontend-framework javascript-libraries javascript-library js-library react react-components react-library semantic-ui

Last synced: about 1 month ago
JSON representation

The official Semantic-UI-React integration

Awesome Lists containing this project

README 

        




  

    

  






  Semantic UI React






  

    Gitter

  

  

    Circle

  

  

    Codecov

  

  

    David

  

  

    npm

  




## Installation & Usage



See the [**Documentation**][2] for an introduction, usage information, and examples.



## Built With





  

  

  




- Amazon Publishing — the full-service publisher of Amazon — [APub.com](https://amazonpublishing.amazon.com)

- Netflix's Edge Developer Experience team's numerous [internal apps](https://github.com/Semantic-Org/Semantic-UI-React/issues/1604)

- Netflix's [flamescope][31]

- Microsoft's [Teams](https://products.office.com/en-US/microsoft-teams/group-chat-software) prototyping



## 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

 

  ### [semantic-ui-react-todos][100]

  Semantic UI React implementation of [react-redux Todo List][101].



## 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:



- [Building CSS with Webpack][24]

- [Building CSS with Meteor][30]

- [Creating a standalone theme][25]



## How Can I Help?



### [Voice Your Opinion][19]



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



### [Contribute][1]



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



### [Good First Issue][21]



Issues labeled [`good first issue`][21] are a great way to ease into development on this project.



### [Missing Components][17]



We're seeking component parity with Semantic UI, plus some addons. There is an issue for every missing component, labeled [`new component`][17]. Just comment on the issue you'd like to take.



### [Help Wanted Label][4]



Any other issue labeled [`help wanted`][4] 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][26] and an amazing community of [contributors][20].



Made possible only by [@jlukic][32] authoring [Semantic UI][5].



Blazing deployments by  Vercel.



[1]: https://github.com/Semantic-Org/Semantic-UI-React/blob/master/.github/CONTRIBUTING.md

[2]: https://react.semantic-ui.com/

[3]: https://facebook.github.io/react/

[4]: https://github.com/Semantic-Org/Semantic-UI-React/labels/help%20wanted

[5]: https://semantic-ui.com/

[6]: https://github.com/Semantic-Org/Semantic-UI-React/milestone/1

[7]: https://github.com/webpack/webpack-dev-server/

[8]: https://github.com/Semantic-Org/Semantic-UI-React/issues/243

[9]: https://github.com/TechnologyAdvice

[10]: https://en.wikipedia.org/wiki/Eating_your_own_dog_food

[11]: https://github.com/Semantic-Org/Semantic-UI-React/issues/247

[12]: https://github.com/Semantic-Org/Semantic-UI-React/issues/243

[13]: https://webpack.github.io

[14]: https://github.com/Semantic-Org/Semantic-UI-React/issues

[15]: https://github.com/skywinder/github-changelog-generator

[17]: https://github.com/Semantic-Org/Semantic-UI-React/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+component%22

[18]: https://github.com/Semantic-Org/Semantic-UI-React/blob/master/CHANGELOG.md

[19]: https://github.com/Semantic-Org/Semantic-UI-React/issues?q=is%3Aopen+RFC+label%3ARFC

[20]: https://github.com/Semantic-Org/Semantic-UI-React/graphs/contributors

[21]: https://github.com/Semantic-Org/Semantic-UI-React/labels/good%20first%20issue

[22]: https://github.com/Semantic-Org/Semantic-UI-React/edit/master/README.md

[23]: https://react.semantic-ui.com/usage#css

[24]: https://medium.com/webmonkeys/webpack-2-semantic-ui-theming-a216ddf60daf

[25]: http://learnsemantic.com/themes/creating.html

[26]: https://github.com/levithomason

[27]: https://github.com/layershifter

[30]: https://github.com/Semantic-Org/Semantic-UI-Meteor

[31]: https://github.com/Netflix/flamescope

[32]: https://github.com/jlukic



[100]: https://github.com/wyc/semantic-ui-react-todos

[101]: https://github.com/reactjs/redux/tree/master/examples/todos