h5p-types
    Preparing search index...

    Type Alias H5PLibrary

    type H5PLibrary = {
        author?: string;
        coreApi?: { majorVersion: number; minorVersion: number };
        description?: string;
        dynamicDependencies?: Dependency[];
        editorDependencies?: Dependency[];
        embedTypes?: ("div" | "iframe")[];
        fullscreen?: 0 | 1;
        license?: string;
        machineName: string;
        majorVersion: number;
        metadataSettings?: { disable: 0 | 1; disableExtraTitleField: 0 | 1 };
        minorVersion: number;
        patchVersion: number;
        preloadedCss?: { path: string }[];
        preloadedDependencies?: Dependency[];
        preloadedJs?: { path: string }[];
        runnable?: 0 | 1;
        title: string;
    }
    Index

    Properties

    author? coreApi? description? dynamicDependencies? editorDependencies? embedTypes? fullscreen? license? machineName majorVersion metadataSettings? minorVersion patchVersion preloadedCss? preloadedDependencies? preloadedJs? runnable? title

    Properties

    author?: string

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

    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.

    Type declaration

    • majorVersion: number
      1
    • minorVersion: number
      0

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

    description?: string

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

    dynamicDependencies?: Dependency[]

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

    editorDependencies?: Dependency[]

    Undocumented but important feature to load widgets when editing H5Ps

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

    List of possible ways to embed the package in the page

    ["div"]

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

    fullscreen?: 0 | 1

    Enables the integrated full-screen button

    0

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

    license?: string

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

    machineName: string

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

    majorVersion: number

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

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

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

    Type declaration

    • disable: 0 | 1
      0
    • disableExtraTitleField: 0 | 1
      1

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

    minorVersion: number

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

    patchVersion: number

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

    preloadedCss?: { path: string }[]

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

    preloadedDependencies?: Dependency[]

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

    preloadedJs?: { path: string }[]

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

    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.

    0

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

    title: string

    Textual library name

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

    Settings

    Member Visibility

    On This Page

    Properties