@ngxi/oui/README.md

Icon set OpenSearch UI for Angular applications

# @ngxi/oui

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

## Icon Set Info

- **Name**: OpenSearch UI
- **Prefix**: `oui`
- **Icons**: 437
- **License**: [Apache 2.0](https://github.com/opensearch-project/oui/blob/main/LICENSE.txt)
- **Author**: [OpenSearch Contributors](https://github.com/opensearch-project/oui)
- **Website**: [https://github.com/opensearch-project/oui](https://github.com/opensearch-project/oui)

## Installation

```sh
pnpm add @ngxi/oui
```

## Usage

```ts
import { Component } from '@angular/core'
import { NgxiOui, ouiWordWrapDisabled } from '@ngxi/oui'

@Component({
  imports: [NgxiOui],
  template: `<svg [ngxiOui]="ouiWordWrapDisabled"></svg>`
})
export class UsageIcon {
  protected ouiWordWrapDisabled = ouiWordWrapDisabled
}
```

## Sponsors

<p align="center">
  <a href="https://cdn.jsdelivr.net/gh/adrian-ub/static/sponsors.svg">
    <img src='https://cdn.jsdelivr.net/gh/adrian-ub/static/sponsors.svg'/>
  </a>
</p>

## License

Apache 2.0 License © 2025-PRESENT [Adrián UB](https://github.com/adrian-ub)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@ngxi/oui?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@ngxi/oui
[npm-downloads-src]: https://img.shields.io/npm/dm/@ngxi/oui?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@ngxi/oui
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@ngxi/oui?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@ngxi/oui
[license-src]: https://img.shields.io/npm/l/@ngxi/oui?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/adrian-ub/ngxi/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/@ngxi/oui