Skip to content

kqualters-elastic/eui

Repository files navigation

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

Elastic UI Framework Build Status

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, use the npm CLI.

npm install @elastic/eui

Running locally

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

npm 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

License

Apache Licensed. Read the FAQ for details.

About

Elastic UI Framework 🙌

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 75.2%
  • JavaScript 22.0%
  • SCSS 2.6%
  • Other 0.2%