Class H5PPlayerUI

Hierarchy

  • Component<IH5PPlayerUIProps>
    • H5PPlayerUI

Constructors

constructor

Properties

context props refs state contextType?

Accessors

h5pInstance h5pObject

Methods

componentDidCatch? componentDidMount componentDidUpdate componentWillMount? componentWillReceiveProps? componentWillUnmount componentWillUpdate? forceUpdate getCopyrightHtml getSnapshotBeforeUpdate hasCopyrightInformation render resize setState shouldComponentUpdate? showCopyright UNSAFE_componentWillMount? UNSAFE_componentWillReceiveProps? UNSAFE_componentWillUpdate?

Constructors

constructor

Properties

context

context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

Readonlyprops

props: Readonly<IH5PPlayerUIProps>

refs

refs: { [key: string]: ReactInstance }

Deprecated

See

Legacy React Docs

state

state: Readonly<{}>

Static OptionalcontextType

contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Example

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}

See

https://react.dev/reference/react/Component#static-contexttype

Accessors

h5pInstance

h5pObject

  • get h5pObject(): IH5P

    The global H5P object / namespace (normally accessible through "H5P..." or "window.H5P") of the content type. Depending on the embed type this can be an object from the internal iframe, so you can use it to break the barrier of the iframe and execute JavaScript inside the iframe.

    Only available after the initialized event was fired. Important: This object is only partially typed and there are more properties and methods on it!

    Returns IH5P

Methods

OptionalcomponentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

componentDidUpdate

OptionalcomponentWillMount

OptionalcomponentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

OptionalcomponentWillUpdate

forceUpdate

  • forceUpdate(callback?: () => void): void

    Parameters

    • Optionalcallback: () => void

    Returns void

getCopyrightHtml

  • getCopyrightHtml(): string

    Returns the copyright notice in HTML that you can insert somewhere to display it. Undefined if there is no copyright information.

    Returns string

getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(): void

    Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

    Note: the presence of this method prevents any of the deprecated lifecycle events from running.

    Returns void

hasCopyrightInformation

render

resize

  • resize(): void

    Asks the H5P content to resize itself inside the dimensions of the container.

    Has no effect until the H5P object has fully initialized.

    Returns void

setState

  • setState<K extends never>(
        state:
            | {}
            | (
                prevState: Readonly<{}>,
                props: Readonly<IH5PPlayerUIProps>,
            ) => {} | Pick<{}, K>
            | Pick<{}, K>,
        callback?: () => void,
    ): void

    Type Parameters

    • K extends never

    Parameters

    • state:
          | {}
          | (
              prevState: Readonly<{}>,
              props: Readonly<IH5PPlayerUIProps>,
          ) => {} | Pick<{}, K>
          | Pick<{}, K>
    • Optionalcallback: () => void

    Returns void

OptionalshouldComponentUpdate

  • shouldComponentUpdate(
        nextProps: Readonly<IH5PPlayerUIProps>,
        nextState: Readonly<{}>,
        nextContext: any,
    ): boolean

    Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component.render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IH5PPlayerUIProps>
    • nextState: Readonly<{}>
    • nextContext: any

    Returns boolean

showCopyright

OptionalUNSAFE_componentWillMount

OptionalUNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(
        nextProps: Readonly<IH5PPlayerUIProps>,
        nextContext: any,
    ): void

    Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component.setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<IH5PPlayerUIProps>
    • nextContext: any

    Returns void

    Deprecated

    16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

    See

OptionalUNSAFE_componentWillUpdate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods