@opensearch-staging/oui
Advanced tools
The OpenSearch UI Framework is a collection of React UI components for quickly building user interfaces at OpenSearch Project. 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 OUI framework aesthetic, and how to use them in your products. We also have a FAQ that covers common usage questions.
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.
yarn add @opensearch-project/oui @elastic/datemath moment prop-types
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
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
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".
Apache Licensed. Read the FAQ for details.
FAQs
OpenSearch UI Component Library
The npm package @opensearch-staging/oui receives a total of 0 weekly downloads. As such, @opensearch-staging/oui popularity was classified as not popular.
We found that @opensearch-staging/oui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 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
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
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.