Sign up

smith / eui
forked from elastic/eui

Elastic UI Framework
elastic.github.io/eui/
Apache-2.0 License
0 stars 374 forks

Star
Watch

Code
Pull requests
Actions
Projects
Security
Insights

master
Go to file

This branch is 986 commits behind elastic:master.

Pull request Compare

View code

README.md

Elastic UI Framework
The Elastic UI Framework is a collection of React UI components for quickly building user interfaces at Elastic. Not
using React? No problem! You can still use the CSS behind each component.
You should check out our living style guide, which contains many examples on how components in the EUI framework
aesthetic, and how to use them in your products. We also have a FAQ that covers common usage questions.

Installation
To install the Elastic UI Framework into an existing project, use the yarn CLI ( npm is not supported).
 yarn add @elastic/eui

Note that EUI itself has some dependencies itself mostly around management of dates and times. If you are installing it
into a blank project you will need to install the following with it. You can read more about other ways to consume EUI.

yarn add @elastic/eui @elastic/datemath moment

Running Locally
Node
We depend upon the version of node defined in .nvmrc.
You will probably want to install a node version manager. nvm is recommended.
To install and use the correct node version with nvm :

nvm install

Documentation
You can run the documentation locally at http://localhost:8030/ by running.

yarn
yarn start

Goals
The primary goal of this library is to provide reusable UI components that can be used throughout Elastic's web
products. As React components, they remove CSS from the process of building UIs. As a single source of truth, the
framework allows our designers to make changes to our aesthetic directly in the code. And unit test coverage for the UI
components allows us to deliver a stable "API for user interfaces".

Contributing
You can find documentation around creating and submitting new components in CONTRIBUTING.md.

Wiki
Consumption
Consuming EUI
Using EUI with react-router

Maintenance
Component design
Component development
Creating components manually
Creating components with Yeoman
 Testing
Theming
Releasing versions

License
Apache Licensed. Read the FAQ for details.

Releases
203 tags

Languages

JavaScript 70.2% TypeScript 20.3% CSS 9.3% Other 0.2%

© 2020 GitHub, Inc.

Terms
Privacy
Security
Status
Help
Contact GitHub
Pricing
API
Training
Blog
About