Introduction
Welcome to NeUI, the new component library by Neugelb and for all kinds of Neugelb projects.
NeUI was made not to be a competitor to established component libraries like MUI or Chakra but to be a base library with sane defaults that does most of the legwork of setting up a whitelabel design system for many different kinds of projects which focuses on frictionless DX, accessibility and great page performance with as little effort as possible.
As such, it tries to be opinionated where it makes sense while also giving you as a developer the required flexibility to create complex components.
Further into this documentation we will go into the main concepts of NeUI, the philosophy behind many of the choices made while creating this library and how to use it most effectively.
Technology
Due to the endless possibilities that open-source brings and the lack of time and effort that can realistically be put into this system, we make great use of the work of other technologies.
Here is a list of the main ones being used to enable NeUI.
| Technology | Use-Case | Documentation | License |
|---|---|---|---|
| Radix UI | Accessible component primitives | https://www.radix-ui.com/docs/primitives/overview/introduction | MIT |
| Stitches | Zero-runtime styling | https://stitches.dev/ | MIT |
| Motion One | Web Animation API based motion library | https://motion.dev/guides/quick-start | MIT |
Since many implementations within NeUI are not made to differ from their base implementations too much, their docs may be as relevant to you as this page is, so I would highly recommend getting familiar with all of these technologies anyway.
NeUI also borrows concepts from the following libraries to enable good DX:
| Library | Concept borrowed | Documentation |
|---|---|---|
| Styled System | Easily editable styling directly as component props | https://styled-system.com/getting-started |
| Framer Motion | Animation controls built the React way | https://www.framer.com/docs/ |
| Bedrock Layout | Composable Layout Primitives | https://www.bedrock-layout.dev/?path=/story/overview-bedrock-layout-primitives--page |
| MUI | sx-Style prop to easily override styling on any component | https://mui.com/ |
| Chakra UI | Grid, SimpleGrid and Stack components | https://chakra-ui.com/getting-started |
So here's a big ❤️ to all the people working on these amazing projects that make NeUI possible (maybe we should consider supporting some of them monetarily).