Elastic UI Framework πŸ™Œ
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Description list framer component (#1276) Nov 1, 2018
docs Updated documentation. Nov 15, 2018
generator-eui EuiComboBox (#567) Mar 30, 2018
scripts TS types output (#1304) Nov 15, 2018
src-docs Adding IBM logos (#1321) Nov 19, 2018
src-framer Description list framer component (#1276) Nov 1, 2018
src Adding IBM logos (#1321) Nov 19, 2018
test Silne30/visual regression rests 521 (#630) Apr 26, 2018
wiki Update consuming.md (#1248) Oct 19, 2018
.babelrc.js build and publish lib and es directories (#1292) Nov 6, 2018
.editorconfig Moving things around and isolating build process Oct 18, 2017
.eslintrc.json Fix eslint extends order so kibana rules become more important (#927) Jun 18, 2018
.gitignore TS types output (#1304) Nov 15, 2018
.npmignore TS types output (#1304) Nov 15, 2018
.nvmrc Rename .node-version -> .nvmrc. Add setup guide. (#508) Mar 13, 2018
.prettierrc Fix lint tasks and introduce prettier (#576) Mar 27, 2018
.sass-lint-fix.yml [WIP] SASS linting (#1283) Nov 12, 2018
.sass-lint.yml [WIP] SASS linting (#1283) Nov 12, 2018
CHANGELOG.md Adding IBM logos (#1321) Nov 19, 2018
CONTRIBUTING.md manual revert of #657, changelog to h2s (#661) Apr 11, 2018
FAQ.md Remove copy about benefits from component-development, move it into F… Nov 22, 2017
LICENSE Apache License 2.0 (#20) Oct 24, 2017
README.md Update Installation readme section to reference yarn instead of npm (#… Oct 17, 2018
package.json Bump nodegit to fix yarn install (#1323) Nov 19, 2018
preinstall_check.js Changing EUI to use the lodash fork and forcing yarn usage (#1217) Sep 27, 2018
tsconfig.json TS types output (#1304) Nov 15, 2018
tslint.yaml Add src-framer files to support Framer X (#1264) Oct 31, 2018
yarn.lock Bump nodegit to fix yarn install (#1323) Nov 19, 2018

README.md

🚨 WARNING While open source, the intended consumers of this repository are Elastic products. Read the FAQ for details.

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 look and feel, and how to use them in your products.

Installation

To install the Elastic UI Framework into an existing project, use the yarn CLI (npm is not supported).

yarn add @elastic/eui

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 look-and-feel 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

Maintenance

License

Apache Licensed. Read the FAQ for details.