---
title: "openvibe-sdk/ui · OpenVibe.Services"
canonical: "https://openvibe.services/docs/sdk/ui"
updated: null
---

# openvibe-sdk/ui · OpenVibe.Services

HTML: [openvibe-sdk/ui · OpenVibe.Services](https://openvibe.services/docs/sdk/ui)

# `openvibe-sdk/ui`

Generated at 2026-11-13 06:25:48 UTC from [`openvibe-contracts v0.419.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.419.0) and [`openvibe-sdk v0.161.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.161.0).

From `types/ui.d.ts` (both). Declarations are shown verbatim.

## type ProgressState

~~~~
export type ProgressState = 'waiting' | 'sending' | 'paused' | 'processing' | 'done' | 'failed';
~~~~

## interface ProgressUpdate

~~~~
export interface ProgressUpdate {
    state?: ProgressState;
    done?: number;
    total?: number;
    message?: string;
}
~~~~

## function progress

Requires the shared ov-upload.js and ov-upload.css assets on the page.

~~~~
export declare function progress(el: HTMLElement, options?: { onRetry?(): void }): {
    update(next: ProgressUpdate): void;
    destroy(): void;
};
~~~~