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
Что это такое?Evergreen — это React UI-фреймворк от Segment: набор готовых, аккуратных React-компонентов корпоративного уровня для веб-приложений, которые работают сразу из коробки.
Это фреймворк, на котором строится всё приложение, или набор компонентов на выбор?Это библиотека компонентов: множество компонентов и инструментов, которые подключаются по одному, — всё построено на React-примитиве ui-box, чтобы их было удобно комбинировать.
Как добавить её в своё React-приложение?Установите пакет evergreen-ui (npm install evergreen-ui), затем импортируйте нужные компоненты — всё работает в стандартных React-настройках вроде Create React App.
Кроме React что-то ещё нужно?Ничего, кроме React и npm — пакет сам подтягивает свои зависимости (downshift, утилиты lodash); для сборки репозитория из исходников нужен Node 14+.
Она навязывает свою систему стилей?Используется CSS-in-JS — Evergreen поставляет собственное решение на базе ui-box, — поэтому стили живут прямо в JavaScript, а не в отдельных CSS-файлах.
Она только для корпоративных приложений?Дизайн-язык ориентирован на веб-приложения корпоративного уровня, но сами компоненты универсальные и работают из коробки в любом React-приложении.
Можно бесплатно использовать в коммерческих проектах?Да — лицензия MIT, бесплатно, в том числе в коммерческих целях. Один нюанс: входящие в комплект иконки BlueprintJS распространяются по собственной версии лицензии Apache 2.0.
Можно настроить внешний вид под свою тему?Да — Evergreen из коробки поддерживает мощный механизм тем, и в документации тема оформления подробно разобрана.
Работает ли она с серверным рендерингом?Да — есть простая поддержка SSR с автоматической гидратацией через функцию extractStyles(), а в репозитории есть примеры настройки для Next.js и GatsbyJS.
Почему Segment сделал собственный UI-кит?Их ключевые убеждения: невозможно предугадать все будущие требования, поэтому стоит строить системы, готовые к изменениям; давать разумные значения по умолчанию, оставляя полный контроль, когда он нужен; и делать работу с библиотекой и вклад в неё приятными — отсюда упор на документацию и удобство для разработчика.
Насколько болезненны обновления мажорных версий?Критические изменения сопровождаются руководством по миграции — для перехода на v7 в репозитории опубликован такой гайд, — так что у вас есть документированный путь обновления, а не догадки.
Creator
segmentio
Size
226.2 MB
Stars
12.4K
Age
9y
Commits · 90 Days