Semantic-UI-React README

The project's README from github.com/Semantic-Org/Semantic-UI-React. As one markdown file: README.md.

Semantic UI React

Gitter Circle Codecov David npm

Installation & Usage

See the Documentation for an introduction, usage information, and examples.

Built With

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

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.

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

Credit

Created by @levithomason and an amazing community of contributors.

Made possible only by @jlukic authoring Semantic UI.

Blazing deployments by Vercel.

Semantic-UI-React (Semantic-Org/Semantic-UI-React)

Searching Database…

13.2K ·GitHub
Semantic-UI-React
What is this?The official Semantic UI integration for React: a library of ready-made UI components you compose in a React app. It is MIT-licensed and the repo has about 13,000 stars.
Is it a component library, or does it come with styles?React components only — it is a library, not a styled framework. Each component renders valid Semantic UI HTML; no CSS is included.
How do I add it to a project?Install the semantic-ui-react package from npm, then follow the official documentation for an introduction, usage, and examples.
Do I need anything else for the components to look right?Yes — a Semantic UI CSS theme. The docs on CSS Usage cover the options, including building the CSS with Webpack or Meteor and creating a standalone theme.
Does it cover every component Semantic UI has?Not all of them yet. The goal is full parity with Semantic UI plus some addons, and each still-missing component has its own tracked issue labeled 'new component'.
Who uses it in production?Netflix's Edge Developer Experience team uses it in numerous internal apps and in Flamescope, Amazon Publishing built APub.com with it, and Microsoft used it for Teams prototyping.
What principles does the library commit to?No animation dependencies, simple declarative component APIs instead of brittle HTML markup, complete keyboard support and accessibility, full Semantic UI definition support — with everything documented and tested.
Can I use custom icons instead of the built-in set?Yes — render instead of ; the FAQ links to detailed info and examples.
What are similar projects?fluentui, arc-library, chakra-ui, bootstrap-vue, base-ui, reactstrap, headlessui, react-slick
Which topics is it in?react-components, icons, components, frontend-framework, ui-library, accessibility, component-library, javascript-library, ui-components, css, ui, web-development
Creator
Semantic-Org
Size
201.2 MB
Stars
13.2K
Updated
CommitNov 22Releasev3.0.0-beta.2Dec 30
Age
11y
Commits · 90 Days