Class UiContainer

A component that does all the coordination between UI components.

It provides all UI components with the PlayerContext, so they can access the styling and player.
It provides slots for UI components to be places in the top/center/bottom positions.
It uses animations to fade the UI in and out when applicable.

Hierarchy

PureComponent<React.PropsWithChildren<UiContainerProps>, UiContainerState>
- UiContainer

Implements

UiControls

Index

Constructors

Properties

Accessors

buttonsEnabled_

Methods

closeCurrentMenu_ componentDidMount componentWillUnmount enterPip_ onUserAction_ openMenu_ render

Constructors

constructor

new UiContainer(props): UiContainer
Parameters
- props: UiContainerProps
Returns UiContainer
Overrides PureComponent<React.PropsWithChildren<UiContainerProps>, UiContainerState>.constructor
- Defined in ui/components/uicontroller/UiContainer.tsx:207

Properties

`Static` initialState

initialState: UiContainerState = ...

Accessors

buttonsEnabled_

get buttonsEnabled_(): boolean
Returns boolean
Implementation of UiControls.buttonsEnabled_
- Defined in ui/components/uicontroller/UiContainer.tsx:300

Methods

closeCurrentMenu_

closeCurrentMenu_(): void
Returns void
Implementation of UiControls.closeCurrentMenu_
- Defined in ui/components/uicontroller/UiContainer.tsx:321

componentDidMount

componentDidMount(): void
Returns void
Overrides PureComponent.componentDidMount
- Defined in ui/components/uicontroller/UiContainer.tsx:212

componentWillUnmount

componentWillUnmount(): void
Returns void
Overrides PureComponent.componentWillUnmount
- Defined in ui/components/uicontroller/UiContainer.tsx:231

enterPip_

enterPip_(): void
Returns void
Implementation of UiControls.enterPip_
- Defined in ui/components/uicontroller/UiContainer.tsx:329

onUserAction_

onUserAction_(): void
Request to show the UI due to user input.

Returns void
Implementation of UiControls.onUserAction_
- Defined in ui/components/uicontroller/UiContainer.tsx:307

openMenu_

openMenu_(menuConstructor): void
Parameters
- menuConstructor: (() => ReactNode)
  - - (): ReactNode
    - Returns ReactNode
Returns void
Implementation of UiControls.openMenu_
- Defined in ui/components/uicontroller/UiContainer.tsx:315

render

render(): Element
Returns Element
Overrides PureComponent.render
- Defined in ui/components/uicontroller/UiContainer.tsx:407

Generated using TypeDoc