# media-status-indicator

Display temporary visual feedback for keyboard and gesture actions

## Import

```ts
import '@videojs/html/ui/status-indicator';
import '@videojs/html/ui/status-indicator-value';
```

## Anatomy

```html
<media-status-indicator>
  <media-status-indicator-value></media-status-indicator-value>
</media-status-indicator>
```

## Behavior

`<media-status-indicator>` displays feedback for actions emitted by a [`<media-hotkey>`](https://videojs.org/docs/framework/html/reference/components/hotkey) or [`<media-gesture>`](https://videojs.org/docs/framework/html/reference/components/gesture) in the same player `<media-container>`. It does not react to buttons, direct player-store changes, or media state changes on their own.

The input event arrives before its action is resolved. The indicator uses the media snapshot from that moment to predict the next visual status:

| Action | `data-status` | Value |
| --- | --- | --- |
| `togglePaused` | `"play"` or `"pause"` | Translated playing or paused label |
| `toggleMuted` | `"volume-off"`, `"volume-low"`, or `"volume-high"` | Predicted volume percentage |
| `volumeStep` | `"volume-off"`, `"volume-low"`, or `"volume-high"` | Predicted volume percentage |
| `toggleSubtitles` | `"captions-on"` or `"captions-off"` | Translated captions label |
| `toggleFullscreen` | `"fullscreen"` or `"exit-fullscreen"` | Translated fullscreen label |
| `togglePictureInPicture` | `"pip"` or `"exit-pip"` | Translated picture-in-picture label |

`toggleSubtitles` is ignored when the player reports that no captions or subtitles are available. Seek actions, `toggleControls`, playback-rate actions, and custom actions do not open this indicator.

Use `actions` to allow only some of the supported actions. Omitting it allows all supported actions.

Set the `actions` attribute to action names separated by commas, whitespace, or both:

```html
<media-status-indicator actions="togglePaused, toggleMuted">
  <media-status-indicator-value></media-status-indicator-value>
</media-status-indicator>
```

The indicator closes after `closeDelay`, which defaults to 800 milliseconds. A repeated handled action updates the current value and restarts that close timer without replaying the entry transition.

The element remains in the document with `hidden` until the next handled action.

## Styling

| Attribute | Values | Description |
| --- | --- | --- |
| `data-open` | Present / absent | Present while the indicator is open |
| `data-status` | `"play"`, `"pause"`, `"volume-off"`, `"volume-low"`, `"volume-high"`, `"captions-on"`, `"captions-off"`, `"fullscreen"`, `"exit-fullscreen"`, `"pip"`, or `"exit-pip"` | Predicted status for the handled action |
| `data-starting-style` | Present / absent | Present during the open transition |
| `data-ending-style` | Present / absent | Present during the close transition |

Use `data-status` to select an icon or other visual treatment, and use the transition attributes for entry and exit styles.

```css
media-status-indicator[data-status="play"] {
  color: green;
}

media-status-indicator[data-starting-style],
media-status-indicator[data-ending-style] {
  opacity: 0;
}
```

## Accessibility

`<media-status-indicator>` is visual feedback and does not create a live region. Keep every action available through keyboard-operable controls, and pair the player with [`<media-status-announcer>`](https://videojs.org/docs/framework/html/reference/components/status-announcer) when state changes should be announced to screen readers. Do not make `<media-status-indicator-value>` a live region.

## Examples

### Basic Usage

Focus the player, then press K to play or pause, M to mute, F for fullscreen, C for captions, or I for picture-in-picture.

**index.html**

```html
<video-player>
  <media-container class="html-status-indicator-basic" tabindex="0">
    <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop>
      <track kind="captions" src="/docs/demos/captions-button/captions.vtt" srclang="en" label="English" />
    </video>
    <p class="html-status-indicator-basic__instructions">
      Focus the player · K: play/pause · M: mute · F: fullscreen · C: captions · I: picture-in-picture
    </p>
    <media-status-indicator
      class="html-status-indicator-basic__indicator"
      actions="togglePaused toggleMuted toggleSubtitles toggleFullscreen togglePictureInPicture"
      aria-hidden="true"
    >
      <media-status-indicator-value class="html-status-indicator-basic__value"></media-status-indicator-value>
    </media-status-indicator>
    <media-hotkey keys="k" action="togglePaused"></media-hotkey>
    <media-hotkey keys="m" action="toggleMuted"></media-hotkey>
    <media-hotkey keys="f" action="toggleFullscreen"></media-hotkey>
    <media-hotkey keys="c" action="toggleSubtitles"></media-hotkey>
    <media-hotkey keys="i" action="togglePictureInPicture"></media-hotkey>
  </media-container>
</video-player>
```

**index.css**

```css
.html-status-indicator-basic {
  position: relative;
}

.html-status-indicator-basic:focus-visible {
  outline: 3px solid #60a5fa;
  outline-offset: 2px;
}

.html-status-indicator-basic video {
  display: block;
  width: 100%;
}

.html-status-indicator-basic__instructions {
  position: absolute;
  top: 10px;
  right: 10px;
  left: 10px;
  padding: 6px 10px;
  margin: 0;
  color: white;
  text-align: center;
  background: rgb(0 0 0 / 70%);
  border-radius: 4px;
}

.html-status-indicator-basic__indicator {
  position: absolute;
  top: 50%;
  left: 50%;
  display: grid;
  min-width: 92px;
  padding: 16px;
  color: white;
  pointer-events: none;
  background: rgb(0 0 0 / 72%);
  border-radius: 12px;
  place-items: center;
  transform: translate(-50%, -50%);
  transition:
    opacity 160ms ease-in-out,
    scale 160ms ease-in-out;
}

.html-status-indicator-basic__indicator::before {
  font-size: 28px;
  font-weight: 700;
  line-height: 1;
}

.html-status-indicator-basic__indicator[data-status="play"]::before {
  content: "▶";
}

.html-status-indicator-basic__indicator[data-status="pause"]::before {
  content: "Ⅱ";
}

.html-status-indicator-basic__indicator[data-status="volume-off"]::before {
  content: "🔇";
}

.html-status-indicator-basic__indicator[data-status="volume-low"]::before {
  content: "🔉";
}

.html-status-indicator-basic__indicator[data-status="volume-high"]::before {
  content: "🔊";
}

.html-status-indicator-basic__indicator[data-status="captions-on"]::before,
.html-status-indicator-basic__indicator[data-status="captions-off"]::before {
  content: "CC";
}

.html-status-indicator-basic__indicator[data-status="captions-off"]::before {
  text-decoration: line-through;
}

.html-status-indicator-basic__indicator[data-status="fullscreen"]::before {
  content: "⛶";
}

.html-status-indicator-basic__indicator[data-status="exit-fullscreen"]::before {
  content: "⊠";
}

.html-status-indicator-basic__indicator[data-status="pip"]::before,
.html-status-indicator-basic__indicator[data-status="exit-pip"]::before {
  content: "▣";
}

.html-status-indicator-basic__indicator[data-status="exit-pip"]::before {
  text-decoration: line-through;
}

.html-status-indicator-basic__indicator[data-starting-style],
.html-status-indicator-basic__indicator[data-ending-style] {
  opacity: 0;
  scale: 0.85;
}

.html-status-indicator-basic__value {
  margin-top: 8px;
  font-variant-numeric: tabular-nums;
}
```

**index.ts**

```ts
import '@videojs/html/video/player';
import '@videojs/html/ui/container';
import '@videojs/html/ui/hotkey';
import '@videojs/html/ui/status-indicator';
import '@videojs/html/ui/status-indicator-value';
```

## API Reference

### media-status-indicator

#### Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `actions` | `readonly InputAction[]` | — | Input actions allowed to open the indicator. All supported actions are allowed when omitted. |
| `closeDelay` (attribute `close-delay`) | `number` | — | Delay in milliseconds before the indicator closes. |

#### State

State is reflected as data attributes for CSS styling.

| Property | Type | Description |
| --- | --- | --- |
| `transitionStarting` | `boolean` | Whether the open transition is in progress. |
| `transitionEnding` | `boolean` | Whether the close transition is in progress. |
| `open` | `boolean` | Whether the indicator is open. |
| `generation` | `number` | Increments each time a supported input action updates the indicator. |
| `status` | `ReturnType<typeof deriveStatus> extends infer Details ? Details extends { status: infer Status } ? Status \| null : never : never` | Predicted visual status for the handled input action. |
| `label` | `string \| null` | Translated label for the predicted status. |
| `value` | `string \| null` | Predicted volume percentage for volume actions, otherwise `null`. |

#### Data attributes

| Attribute | Type | Description |
| --- | --- | --- |
| `data-open` | — | Present while the indicator is open. |
| `data-status` | `ReturnType<typeof deriveStatus> extends infer Details ? Details extends { status: infer Status } ? Status \| null : never : never` | Predicted visual status for the handled input action. |
| `data-starting-style` | — | Present during the open transition. |
| `data-ending-style` | — | Present during the close transition. |

### media-status-indicator-value

---

HTML documentation: https://videojs.org/docs/framework/html/llms.txt
All documentation: https://videojs.org/llms.txt