# @openremote/or-vaadin-components

> Vaadin Components packaged as components aligned with the OpenRemote design system

Latest version **1.30.0** (published 2026-09-02) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @openremote/or-vaadin-components
pnpm add @openremote/or-vaadin-components
yarn add @openremote/or-vaadin-components
bun add @openremote/or-vaadin-components
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.30.0 |
| Published | 2026-09-02 |
| First published | 2026-01-12 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 26 |
| Unpacked size | 8.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1908 |
| Author | OpenRemote |
| Maintainers | openremotedeveloper, wborn |

## Links

- npm: https://www.npmjs.com/package/@openremote/or-vaadin-components
- Repository: https://github.com/openremote/openremote
- npm.io page: https://npm.io/package/@openremote/or-vaadin-components

## Dependencies (26)

- [lit](https://npm.io/package/lit.md) ^3.3.1
- [@vaadin/item](https://npm.io/package/@vaadin/item.md) ~25.2.8
- [@vaadin/badge](https://npm.io/package/@vaadin/badge.md) ~25.2.8
- [@vaadin/button](https://npm.io/package/@vaadin/button.md) ~25.2.8
- [@vaadin/dialog](https://npm.io/package/@vaadin/dialog.md) ~25.2.8
- [@vaadin/select](https://npm.io/package/@vaadin/select.md) ~25.2.8
- [@vaadin/slider](https://npm.io/package/@vaadin/slider.md) ~25.2.8
- [@openremote/core](https://npm.io/package/@openremote/core.md) 1.30.0
- [@vaadin/checkbox](https://npm.io/package/@vaadin/checkbox.md) ~25.2.8
- [@vaadin/list-box](https://npm.io/package/@vaadin/list-box.md) ~25.2.8
- [@vaadin/menu-bar](https://npm.io/package/@vaadin/menu-bar.md) ~25.2.8
- [@openremote/model](https://npm.io/package/@openremote/model.md) 1.30.0
- [@vaadin/combo-box](https://npm.io/package/@vaadin/combo-box.md) ~25.2.8
- [@vaadin/text-area](https://npm.io/package/@vaadin/text-area.md) ~25.2.8
- [@vaadin/text-field](https://npm.io/package/@vaadin/text-field.md) ~25.2.8
- [@vaadin/date-picker](https://npm.io/package/@vaadin/date-picker.md) ~25.2.8
- [@vaadin/radio-group](https://npm.io/package/@vaadin/radio-group.md) ~25.2.8
- [@vaadin/time-picker](https://npm.io/package/@vaadin/time-picker.md) ~25.2.8
- [@vaadin/number-field](https://npm.io/package/@vaadin/number-field.md) ~25.2.8
- [@openremote/or-element](https://npm.io/package/@openremote/or-element.md) 1.30.0
- [@vaadin/checkbox-group](https://npm.io/package/@vaadin/checkbox-group.md) ~25.2.8
- [@vaadin/confirm-dialog](https://npm.io/package/@vaadin/confirm-dialog.md) ~25.2.8
- [@vaadin/password-field](https://npm.io/package/@vaadin/password-field.md) ~25.2.8
- [@vaadin/date-time-picker](https://npm.io/package/@vaadin/date-time-picker.md) ~25.2.8
- [@vaadin/vaadin-themable-mixin](https://npm.io/package/@vaadin/vaadin-themable-mixin.md) ~25.2.8
- [@vaadin/multi-select-combo-box](https://npm.io/package/@vaadin/multi-select-combo-box.md) ~25.2.8

## Recent versions

- 1.30.0 (latest) — 2026-09-02
- 1.31.0-snapshot.20260916144308 (snapshot) — 2026-09-16
- 1.31.0-snapshot.20260916130646 — 2026-09-16
- 1.31.0-snapshot.20260915122244 — 2026-09-15
- 1.31.0-snapshot.20260911091633 — 2026-09-11
- 1.31.0-snapshot.20260910125057 — 2026-09-10
- 1.31.0-snapshot.20260910120754 — 2026-09-10
- 1.31.0-snapshot.20260908130403 — 2026-09-08
- 1.31.0-snapshot.20260907094218 — 2026-09-07
- 1.31.0-snapshot.20260904133325 — 2026-09-04
- 1.31.0-snapshot.20260904115341 — 2026-09-04
- 1.31.0-snapshot.20260904102436 — 2026-09-04
- 1.31.0-snapshot.20260903144735 — 2026-09-03
- 1.31.0-snapshot.20260903142507 — 2026-09-03
- 1.31.0-snapshot.20260903135821 — 2026-09-03
- … 426 more at https://npm.io/package/@openremote/or-vaadin-components/versions

## README

# @openremote/or-vaadin-components

[![NPM Version][npm-image]][npm-url]

Package containing [Vaadin Web Components](https://vaadin.com/docs/latest/components), built with [Lit](https://lit.dev), with a slight adjustment to work within the OpenRemote ecosystem.
For documentation you can check out their [website](https://vaadin.com/docs/latest/components).

## Install

```bash
npm i @openremote/or-vaadin-components
yarn add @openremote/or-vaadin-components
```

## Usage

### JavaScript / TypeScript example using a Text Field

Note: using the `document.createElement()` API is an example here. Please check the documentation of your JavaScript framework for proper installation of Lit web components.

```typescript
import "@openremote/or-vaadin-components/or-vaadin-text-field";

// Load text field into the app
const textField = document.createElement("or-vaadin-text-field");
textField.setAttribute("label", "Company name");
textField.setAttribute("value", "OpenRemote");
document.body.appendChild(textField);
```

### Group fields

The group fields `or-vaadin-checkbox-group` and `or-vaadin-radio-group` should use the "native" Vaadin child components, `vaadin-checkbox` and `vaadin-radio-button`, respectively. These are registered when importing the group fields.

```html
<or-vaadin-checkbox-group>
  <vaadin-checkbox></vaadin-checkbox>
  <vaadin-checkbox></vaadin-checkbox>
</or-vaadin-checkbox-group>

<or-vaadin-radio-group>
  <vaadin-radio-button></vaadin-radio-button>
  <vaadin-radio-button></vaadin-radio-button>
</or-vaadin-radio-group>
```

## License

[GNU AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

[npm-image]: https://img.shields.io/npm/v/@openremote/or-vaadin-components.svg
[npm-url]: https://www.npmjs.com/package/@openremote/or-vaadin-components

---
_Source: https://npm.io/package/@openremote/or-vaadin-components · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
