@opensearch-project/oui
Advanced tools
The OpenSearch UI (OUI) Framework is a collection of React UI components for quickly building user interfaces for the OpenSearch Project.
You should check out our living style guide, which contains many examples of components in the OUI framework aesthetic, and how to use them in your products. We also have a FAQ that covers common usage questions.
The primary goal of this library is to provide reusable UI components that can be used in any OpenSearch project web project. 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".
To install the OpenSearch UI Framework into an existing project, use the yarn CLI (npm is not supported).
yarn add @opensearch-project/oui
Note that OUI 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 OUI.
The OpenSearch Project style guidelines and OpenSearch terms documents provide style standards and terminology to be observed when creating OpenSearch Project content.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
This project is licensed under the Apache v2.0 License.
Copyright OpenSearch Contributors. See NOTICE for details.
FAQs
OpenSearch UI Component Library
The npm package @opensearch-project/oui receives a total of 9,095 weekly downloads. As such, @opensearch-project/oui popularity was classified as popular.
We found that @opensearch-project/oui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.