Type alias H5PLibrary

Type declaration

• Optional author?: string

  See

  https://h5p.org/library-definition#libauthor

• Optional coreApi?: {
      majorVersion: number;
      minorVersion: number;
  }

  Specifies the required version of H5P Core API. If not set, v1.0 is assumed, and the library must not use any functionality added in newer versions of H5P Core.

  See

  https://h5p.org/library-definition#libcoreApi

  • majorVersion: number

    Default

    1
    Copy

  • minorVersion: number

    Default

    0
    Copy

• Optional description?: string

  See

  https://h5p.org/library-definition#libdescription

• Optional dynamicDependencies?: Dependency[]

  See

  https://h5p.org/library-definition#libdynamic

• Optional editorDependencies?: Dependency[]

  Undocumented but important feature to load widgets when editing H5Ps

• Optional embedTypes?: ("div" | "iframe")[]

  List of possible ways to embed the package in the page

  Default

  ["div"]
  Copy

  See

  https://h5p.org/library-definition#libembedtypes

• Optional fullscreen?: 0 | 1

  Enables the integrated full-screen button

  Default

  0
  Copy

  See

  https://h5p.org/library-definition#fullscreen

• Optional license?: string

  See

  https://h5p.org/library-definition#liblicense

• machineName: string

  See

  https://h5p.org/library-definition#libmachinename

• majorVersion: number

  See

  https://h5p.org/library-definition#libmajorversion

• Optional metadataSettings?: {
      disable: 0 | 1;
      disableExtraTitleField: 0 | 1;
  }

  Disable metadata completely or just hide title field from content type's form.

  See

  https://h5p.org/library-definition#metadata-settings

  • disable: 0 | 1

    Default

    0
    Copy

  • disableExtraTitleField: 0 | 1

    Default

    1
    Copy

• minorVersion: number

  See

  https://h5p.org/library-definition#libminorversion

• patchVersion: number

  See

  https://h5p.org/library-definition#libpatchversion

• Optional preloadedCss?: {
      path: string;
  }[]

  See

  https://h5p.org/library-definition#libpreloadcss

• Optional preloadedDependencies?: Dependency[]

  See

  https://h5p.org/library-definition#libpreload

• Optional preloadedJs?: {
      path: string;
  }[]

  See

  https://h5p.org/library-definition#libpreloadjs

• Optional runnable?: 0 | 1

  Whether or not this library is runnable. If it is runnable the authoring tool will enable authors to create new instances of content using this library. Values are 0 for not runnable and 1 for runnable.

  Default

  0
  Copy

  See

  https://h5p.org/library-definition#librunnable

• title: string

  Textual library name

  See

  https://h5p.org/library-definition#libtitle