Rich Content
Player
client70 kB
/mediaPlayerPropsPreview
Props
16| Prop | Type | Default |
|---|---|---|
className | string | — |
controls | boolean | true |
labels | Partial<PlayerLabels> | — |
light | string | boolean | false |
loop | boolean | false |
muted | boolean | false |
onClose | (() => void) | — |
onEnded | (() => void) | — |
onError | ((error: unknown) => void) | — |
onReady | (() => void) | — |
opened | boolean | — |
playing | boolean | false |
ratio | number | 16 / 9 |
src required | string | — |
title | ReactNode | — |
volume | number | — |
Slot props
1Each one spreads over an inner element, so you can restyle a region without forking the component.
| Prop | Type | Default |
|---|---|---|
surfaceProps The player inside the frame. It is the only node in the catalogue that renders a peer — react-player — and that is why it is typed with the attributes of the `video` it renders and not with `BoxSlotProps`: the component governs its `src`, its size and its handlers. | Omit<DetailedHTMLProps<VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "ref"> | — |
Also accepts
On top of its own props, this component forwards these groups.
Style props · 128