open-index/open-npm huggingface dataset:
npm package: @iconify-prerendered/vue-oui
Description: OpenSearch UI components for Vue. Designed for ease of use and high performance
Author: Alex Kozack
Latest version: 0.28.1752557097

> **Important**
> 
> This project is maintained by developer from Ukraine 🇺🇦
> 
> I do my best, but due to Russia's ongoing full-scale invasion of Ukraine, I
> barely have the energy to support open source projects.
>
> If my work has been useful to you, please consider
> [supporting Ukraine](https://stand-with-ukraine.pp.ua/) or
> [me personally](https://send.monobank.ua/6SmojkkR9i).
>
> Even your **$1** has an impact!

---

# OpenSearch UI components for Vue

Designed for ease of use and high performance. Each icon in set is a standalone
component.

## Features

- **Easy to use**
  - No plugins required! Compatible with any build tools.
  - Designed for the best compatibility with IDE auto-completion
    ([Demo](https://twitter.com/alex_kozack/status/1560608558127140865)).
  - Zero dependencies.
  - SSR / SSG friendly.
  - TypeScript support.
- **High performance**
  - Does not require any external resources like fonts, css, images.
  - The icon code is embedded in your bundle.
  - Supports tree shaking, so only those icons that you have used will be
    included in the bundle.
  - Works offline.
- Powered by [iconify](https://iconify.design/).

## Usage

```vue
<script setup>
// Import components as usual
import {
	IconWordWrapDisabled,
	IconAnnotation,
	IconTokenRankFeature,
	IconShard,
	IconApps,
	IconTokenHistogram,
} from '@iconify-prerendered/vue-oui'
</script>

<template>
	<!-- And just use it in template -->
  	<IconWordWrapDisabled/>
	<IconAnnotation/>
	<IconTokenRankFeature/>
	<IconShard/>
	<IconApps/>
	<IconTokenHistogram/>
</template>
```

Only these three icons will be included in your bundle. Your bundler may
tree-shake all other icons.

That's all you need. No plugins, extra configs, IDE extensions or something
else.

## Customizing icon default attributes

By default, all icons have only two attributes: `role="img"` and
`aria-hidden="true"`. While you are free to redefine these attributes or add new
ones for each icon, you might want to apply certain attributes, such as `class`
or `style`, to all icons within a set.

To achieve this, you can re-export icons through a `new Proxy` and include
default attributes

```javascript
import * as defaultIcons from '@iconify-prerendered/vue-oui';

// accessing to icon through this Proxy will add additional attributes
export const themedIcons = new Proxy({}, {
  get(_, iconKey) {
    return () =>
      defaultIcons[iconKey]({
        class: 'pre-defined-class',
        // ... any other attributes
      });
  },
});
```

See [full docs](https://github.com/cawa-93/iconify-prerendered/#readme) or
[other available icons sets](https://github.com/cawa-93/iconify-prerendered/#available-icons-sets).