@elastic/eui

What is @elastic/eui?

@elastic/eui is a comprehensive library of UI components for building user interfaces in React applications. It is designed to provide a consistent and flexible design system, primarily used within the Elastic ecosystem, but it can be utilized in any React project. The library includes a wide range of components such as forms, tables, charts, and more, all designed to be accessible and customizable.

What are @elastic/eui's main functionalities?

UI Components

EUI provides a variety of UI components like buttons, forms, and modals. The code sample demonstrates how to use the EuiButton component to create a button that shows an alert when clicked.

import { EuiButton } from '@elastic/eui';

function App() {
  return <EuiButton onClick={() => alert('Button clicked!')}>Click me</EuiButton>;
}

Data Visualization

EUI includes components for data visualization, such as charts and graphs. The code sample shows how to create a simple line chart using the EuiChart component.

import { EuiChart } from '@elastic/eui';

function ChartComponent() {
  return <EuiChart type="line" data={[{ x: 1, y: 2 }, { x: 2, y: 3 }]} />;
}

Theming and Customization

EUI allows for theming and customization of components to fit different design needs. The code sample demonstrates how to use the EuiProvider to apply a dark theme to an application.

import { EuiProvider } from '@elastic/eui';

function ThemedApp() {
  return (
    <EuiProvider colorMode="dark">
      <YourAppComponents />
    </EuiProvider>
  );
}

Other packages similar to @elastic/eui

material-ui

Material-UI (now MUI) is a popular React UI framework that implements Google's Material Design. It offers a wide range of components and customization options similar to EUI, but it is more widely used outside of the Elastic ecosystem and has a larger community and support base.

ant-design

Ant Design is a React UI library with a comprehensive set of components and design guidelines. It is similar to EUI in terms of component variety and customization capabilities, but it follows a different design philosophy and is more popular in the Asian market.

chakra-ui

Chakra UI is a modern React UI library that focuses on simplicity and accessibility. It offers a smaller set of components compared to EUI but emphasizes ease of use and flexibility, making it a good choice for projects that require a lightweight and customizable UI solution.

README

Elastic UI Framework

The Elastic UI Framework is a collection of React UI components for quickly building user interfaces at Elastic.

Resources

• Check out our full documentation site, which contains many examples of components in the EUI framework aesthetic, and how to use them in your products.
• Our FAQ covers common usage questions — for other general questions regarding EUI, check out the Discussions tab.
• For technical instructions and guidelines on usage and development, please refer to our wiki.

License

Dual-licensed under Elastic v2 and Server Side Public License, v1. See Elastic's licensing FAQ for details.