htmlVideo: Video component

In dash: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications

Video component

Description

Video is a wrapper for the <video> HTML5 element. For detailed attribute info see: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video

Usage

htmlVideo(children=NULL, id=NULL, n_clicks=NULL,
n_clicks_timestamp=NULL, key=NULL, role=NULL, autoPlay=NULL,
controls=NULL, crossOrigin=NULL, height=NULL, loop=NULL,
muted=NULL, poster=NULL, preload=NULL, src=NULL, width=NULL,
accessKey=NULL, className=NULL, contentEditable=NULL,
contextMenu=NULL, dir=NULL, draggable=NULL, hidden=NULL,
lang=NULL, spellCheck=NULL, style=NULL, tabIndex=NULL,
title=NULL, loading_state=NULL, ...)

Arguments

children	A list of or a singular dash component, string or number. The children of this component
id	Character. The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.
n_clicks	Numeric. An integer that represents the number of times that this element has been clicked on.
n_clicks_timestamp	Numeric. An integer that represents the time (in ms since 1970) at which n_clicks changed. This can be used to tell which button was changed most recently.
key	Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info
role	Character. The ARIA role attribute
autoPlay	A value equal to: 'autoplay', 'autoplay', 'autoplay' | logical. The audio or video should play as soon as possible.
controls	A value equal to: 'controls', 'controls' | logical. Indicates whether the browser should show playback controls to the user.
crossOrigin	Character. How the element handles cross-origin requests
height	Character | numeric. Specifies the height of elements listed here. For all other elements, use the CSS height property. Note: In some instances, such as <div>, this is a legacy attribute, in which case the CSS height property should be used instead.
loop	A value equal to: 'loop', 'loop' | logical. Indicates whether the media should start playing from the start when it's finished.
muted	A value equal to: 'muted', 'muted' | logical. Indicates whether the audio will be initially silenced on page load.
poster	Character. A URL indicating a poster frame to show until the user plays or seeks.
preload	Character. Indicates whether the whole resource, parts of it or nothing should be preloaded.
src	Character. The URL of the embeddable content.
width	Character | numeric. For the elements listed here, this establishes the element's width. Note: For all other instances, such as <div>, this is a legacy attribute, in which case the CSS width property should be used instead.
accessKey	Character. Keyboard shortcut to activate or add focus to the element.
className	Character. Often used with CSS to style elements with common properties.
contentEditable	Character. Indicates whether the element's content is editable.
contextMenu	Character. Defines the ID of a <menu> element which will serve as the element's context menu.
dir	Character. Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
draggable	Character. Defines whether the element can be dragged.
hidden	A value equal to: 'hidden', 'hidden' | logical. Prevents rendering of given element, while keeping child elements, e.g. script elements, active.
lang	Character. Defines the language used in the element.
spellCheck	Character. Indicates whether spell checking is allowed for the element.
style	Named list. Defines CSS styles which will override styles previously set.
tabIndex	Character. Overrides the browser's default tab order and follows the one specified instead.
title	Character. Text to be displayed in a tooltip when hovering over the element.
loading_state	Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer
...	wildcards allowed have the form: ''data-*', 'aria-*''

Value

named list of JSON elements corresponding to React.js properties and their values

Examples

if (interactive()) {
  library(dash)

  app <- Dash$new()

  app$layout(
    htmlDiv(list(
      htmlVideo(
        src = file.path('https://ia800303.us.archive.org',
              '18/items/bacteria_friend_and_foe',
              'bacteria_friend_and_foe_512kb.mp4',
              fsep = '/'),
        controls = TRUE,
        title = "Bacteria: Friend and Foe"
      )
      )
    )
  )

  app$run_server()
}

dash documentation built on June 23, 2022, 9:11 a.m.