Skip to content

elastic/eui

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Nov 11, 2020
aa1b970 Β· Nov 11, 2020
Jul 14, 2020
Aug 4, 2020
Nov 11, 2020
Jul 27, 2020
Oct 16, 2020
Nov 2, 2020
Nov 11, 2020
Nov 11, 2020
Oct 30, 2020
Feb 6, 2020
Oct 2, 2020
Sep 9, 2020
Oct 18, 2017
May 15, 2020
May 14, 2020
Jun 12, 2020
Apr 29, 2019
Oct 21, 2020
May 15, 2020
Sep 5, 2019
Feb 5, 2019
Nov 12, 2018
Nov 12, 2018
Aug 12, 2020
Nov 11, 2020
Oct 2, 2020
Apr 10, 2020
Mar 20, 2019
Apr 15, 2020
Sep 22, 2020
Nov 11, 2020
Sep 9, 2020
Dec 12, 2018
May 15, 2020
Oct 19, 2020

Repository files navigation

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 of 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 has several peerDependencies requirements that will also need to be installed if starting with a blank project. You can read more about other ways to consume EUI.

yarn add @elastic/eui @elastic/datemath moment prop-types

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 the following.

yarn
yarn start

If another process is already listening on port 8030, the next free port will be used. Alternatively, you can specify a port:

yarn start --port 9000

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".

Wiki

Consumption

Maintenance / Contributing

CONTRIBUTING.md

License

Apache Licensed. Read the FAQ for details.