evergreen README

The project's README from github.com/segmentio/evergreen. As one markdown file: README.md.

Evergreen, A Design System for the Web. Evergreen is a React UI Framework for building ambitious products on the web. Brought to you by Segment.



Documentation & Community

Evergreen v7 Migration guide

Evergreen v7 migration guide

Install and use components

🌲 Evergreen is made up of multiple components and tools which you can import one by one. All you need to do is install the evergreen-ui package:

$ yarn add evergreen-ui
# or
$ npm install --save evergreen-ui

A working version, assuming you are using something like Create React App, might look like this:

import React from 'react'
import ReactDOM from 'react-dom'
import { Button } from 'evergreen-ui'

ReactDOM.render(<Button>I am using 🌲 Evergreen!</Button>, document.getElementById('root'))

Core values of 🌲 Evergreen

FAQ

Theming support?

Evergreen supports a robust theming layer out of the box. You can check out these docs for more information regarding theming in Evergreen.

How does Server Side Rendering (SSR) work?

Evergreen offers easy Server Side Rendering (SSR) and automatic hydration.

Evergreen bundles its own CSS-in-JS solution from ui-box. To make it super easy to do server side rendering and hydration, Evergreen exposes a extractStyles() function.

Contributing to Evergreen

Please see CONTRIBUTING.md for more information on how to contribute!

🎉 Contributors

We will add you to the list if you make any meaningful contribution!

This project is maintained by Segment

Please take a look at the contributing guide to better understand what to work on.

👏 Respect earns Respect

Please respect our Code of Conduct, in short:

License

Evergreen is released under the MIT license. The BlueprintJS icons are licensed under a custom Apache 2.0 license.

Copyright © 2021 Segment.io, Inc.

evergreen (segmentio/evergreen)

Searching Database…

12.4K ·GitHub
What is this?Evergreen is Segment's React UI framework — a set of polished, enterprise-grade React components for web apps that work out of the box.
Is it a framework I build my whole app on, or a set of components I pick from?It's a component library: multiple components and tools you import one by one, all built on top of the ui-box React UI primitive for composability.
How do I add it to my React app?Install the evergreen-ui package (npm install evergreen-ui), then import the components you need — it works in standard React setups like Create React App.
Do I need anything besides React to use it?Nothing beyond React and npm — the package pulls its own dependencies (downshift, lodash helpers); building the repo from source needs Node 14+.
Does it force its own styling system on me?It uses CSS-in-JS — Evergreen bundles its own solution from ui-box — so styles live in your JavaScript rather than separate CSS files.
Is it meant only for enterprise apps?The design language targets enterprise-grade web applications, but the components are general-purpose and work out of the box in any React app.
Can I use it in commercial projects for free?Yes — MIT, free even commercially. One caveat: the bundled BlueprintJS icons are licensed under a custom Apache 2.0 license.
Can I customize the look with my own theme?Yes — Evergreen supports a robust theming layer out of the box, and the documentation covers theming in detail.
Does it work with server-side rendering?Yes — it offers easy SSR with automatic hydration through an extractStyles() function, and the repo includes example setups for Next.js and GatsbyJS.
Why did Segment build its own UI kit?Its core beliefs: you can never predict all future requirements, so build systems that anticipate change; give smart defaults with full control when needed; and keep using and contributing to the library pleasant — hence the emphasis on documentation and developer experience.
How rough are major version upgrades?Breaking changes come with a migration guide — the repo publishes one for the jump to v7 — so you get a documented upgrade path rather than guesswork.
Creator
segmentio
Size
226.2 MB
Stars
12.4K
Age
9y
Commits · 90 Days