Class H5PEditorUI

Hierarchy

  • Component<IH5PEditorUIProps>
    • H5PEditorUI

Constructors

constructor

Methods

componentDidCatch? componentDidMount componentDidUpdate componentWillMount? componentWillReceiveProps? componentWillUnmount componentWillUpdate? forceUpdate getSnapshotBeforeUpdate render save setState shouldComponentUpdate? 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<IH5PEditorUIProps>

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

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

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

render

save

  • save(): Promise<{ contentId: string; metadata: IContentMetadata }>

    Call this method to save the current state of the h5p editor. This will result in a call to the saveContentCallback that was passed in the through the props.

    Returns Promise<{ contentId: string; metadata: IContentMetadata }>

    Throws

    an error if there was a problem (e.g. validation error of the content)

setState

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

    Type Parameters

    • K extends never

    Parameters

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

    Returns void

OptionalshouldComponentUpdate

  • shouldComponentUpdate(
        nextProps: Readonly<IH5PEditorUIProps>,
        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<IH5PEditorUIProps>
    • nextState: Readonly<{}>
    • nextContext: any

    Returns boolean

OptionalUNSAFE_componentWillMount

OptionalUNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(
        nextProps: Readonly<IH5PEditorUIProps>,
        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<IH5PEditorUIProps>
    • nextContext: any

    Returns void

    Deprecated

    16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

    See

OptionalUNSAFE_componentWillUpdate

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR