Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all the options and implied behaviors #2932

Open
hartman opened this issue Dec 19, 2015 · 1 comment
Open

Document all the options and implied behaviors #2932

hartman opened this issue Dec 19, 2015 · 1 comment
Labels
documentation pinned Things that stalebot shouldn't close automatically

Comments

@hartman
Copy link
Contributor

hartman commented Dec 19, 2015

I'm trying to figure out how it all works, but some of it is really badly documented, documented in locations that are no longer considered to be 'canonical', documented for the old version, or not documented at all.

For controlBar, i figured out:

  • children, an array. determines 'presence in the dom and order'. can be used to override the default of:
[
    "playToggle",
    "volumeMenuButton",
    "currentTimeDisplay",
    "timeDivider",
    "durationDisplay",
    "progressControl",
    "remainingTimeDisplay",
    "customControlSpacer",
    "playbackRateMenuButton",
    "chaptersButton",
    "subtitlesButton",
    "captionsButton",
    "fullscreenToggle"
]
  • the skin determines default visibility of controls.
  • some of the controls are present but conditionally hidden (ie. chapters, captions etc)
  • a hidden control has the vjs-hidden class, which can be switched with the .show() and the .hide() methods of the control.
  • apparently currentTimeDisplay, timeDivider and durationDisplay are the only default present children that do not 'appear' to listen .show() and .hide(), as they by default are hidden by the skin.
  • there are 'options', but no one really knows all the available options and their names :)
@gkatsev
Copy link
Member

gkatsev commented Mar 28, 2016

Fwiw, I updated the components.md doc in the doc/guides directly to have the latest version of components on the control bar/player.

@gkatsev gkatsev added the pinned Things that stalebot shouldn't close automatically label Jul 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation pinned Things that stalebot shouldn't close automatically
Projects
None yet
Development

No branches or pull requests

2 participants