bitmovin-player-ui
    Preparing search index...

    Class RootNavigationGroup

    Extends NavigationGroup and provides additional logic for hiding and showing the UI on the root container.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    afterNavigation?: AfterNavigationCallback

    If overwritten, it is called when a directional navigation finished.

    Will be called after the navigation finished regardless if the navigation was successful or not. If navigation was not successful, the target element will be undefined. This can be used for implementing a custom behavior when the user navigations at the edge of the spatial components. E.g., presenting an additional overlay when pressing a direction while the last component is already focused.

    {Direction} The direction to move along

    {AnyComponent | undefined} The focused target element for the event or undefined if no target was found

    container: UIContainer
    onAction?: ActionCallback

    If overwritten, allows to implement custom action behavior. Per default, the internal handler will still be executed. To prevent execution of the default action handler, call preventDefault(). Return true if your handler consumed the action event. Return false or undefined if it did not. Consumed events will not be handled any further by spatial navigation.

    {Action} The action that was called

    {AnyComponent} The target component that action was called on

    {() => void} A function that, when called, will prevent the execution of the default handler

    true if the event was handled, false or undefined otherwise

    onNavigation?: NavigationCallback

    If overwritten, allows to implement custom navigation behavior. Per default, the internal handler will still be executed. To prevent execution of the default navigation handler, call preventDefault(). Return true if your handler consumed the navigation event. Return false or undefined if it did not. Consumed events will not be handled any further by spatial navigation.

    {Direction} The direction to move along

    {AnyComponent} The target component for the event

    {() => void} A function that, when called, will prevent the execution of the default handler

    true if the event was handled, false or undefined otherwise

    Methods