A jQuery wrapper around window.
Copyrights for an H5P Content Library
H5P.ContentType is a base class for all content types. Used by newRunnable().
Functions here may be overridable by the libraries. In special cases, it is also possible to override H5P.ContentType on a global level.
NOTE that this doesn't actually 'extend' the event dispatcher but instead it creates a single instance which all content types shares as their base prototype. (in some cases this may be the root of strange event behavior)
Helper object for keeping coordinates in the same format all over.
Simple data structure class for storing a single field
An ordered list of copyright fields for media
A simple and elegant class for creating thumbnails of images
Create an accessible tooltip
1.25 / moodle-1.23
Use fullscreenSupported instead
When embedded, the communicator helps talk to the parent page.
Maps copyright license codes to their human readable counterpart.
Optional externalIndicates if H5P is embedded on an external page using iframe.
Private fullIf the current browser supports Element#requestFullscreen, this property
will be set to an empty string.
If the current browser does not support Element#requestFullscreen but has a
vendor-prefixed version of it, this property will contain the prefix.
If the current browser does not support fullscreen mode at all, this property
will be undefined.
True if the current browser supports fullscreen mode.
A list over H5P instances on the current page.
True if H5P content is rendered inside an iframe.
True if H5P content is in fullscreen mode.
Use H5P.fullscreen() or H5P.semiFullScreen() to enter fullscreen mode.
Use H5P.exitFullScreen() to exit fullscreen mode.
Keeps track of when each H5P content instance was initiated.
Optional preventPrevent H5P Core from initializing. Must be overriden before document ready.
Optional safariIs set to the Safari version number if the current browser is Safari (but only if it does not support fullscreen mode).
Helper for adding a query parameter to an existing path that may already contain one or a hash.
URL to add query parameter to.
Query parameter to add on the format key1=value1&key2=value2.
const path = "https://example.com";
const parameter = "foo=bar";
const result = H5P.addQueryParameter(path, parameter);
// result === "https://example.com?foo=bar"
const path = "https://example.com?foo=bar";
const parameter = "baz=qux";
const result = H5P.addQueryParameter(path, parameter);
// result === "https://example.com?foo=bar&baz=qux"
const path = "https://example.com?foo=bar";
const parameter = "baz=qux&quux=quuz";
const result = H5P.addQueryParameter(path, parameter);
// result === "https://example.com?foo=bar&baz=qux&quux=quuz"
const path = "https://example.com#foo";
const parameter = "bar=baz";
const result = H5P.addQueryParameter(path, parameter);
// result === "https://example.com?bar=baz#foo"
Show a toast message.
The reference element could be DOM elements the toast should be attached to, or e.g. the document body for general toast messages.
Reference element to show toast message for.
Message to show.
Optional config: { Configuration.
Optional duration?: numberToast message length in ms. Default: 3000
Relative positioning of the toast.
Optional horizontal?: "left" | "right" | "before" | "centered" | "after"Optional noOptional noOptional noOptional noOptional noOptional noOptional offsetOptional offsetOptional overflowOptional vertical?: "top" | "bottom" | "centered" | "above" | "below"Optional style?: stringId for the tooltip. Default: h5p-toast
const parentElement = document.body
const message = "Hello world!"
H5P.attachToastTo(parentElement, message)
Private deletePrivate Delete user data for given content
What content to remove data for
Identifies the set of data for this content
Optional subContentId: H5PContentIdIdentifies which data belongs to sub content
Gather a flat list of copyright information from the given parameters.
Used to collect all information in.
To search for file objects in.
Used to insert thumbnails for images.
Optional extras: { Extras.
Library name of some kind. Metadata of the content instance.
Metadata
Optional exitCallback: (() => void)Optional body: JQuery<HTMLElement>Optional forceSemiFullScreen: booleanFunction for getting content for a certain ID
Optional contentId: H5PContentIdUse getPath instead
Gather copyright information for the given content.
H5P instance to get copyright information for.
Parameters of the content instance.
Identifies the H5P content
Metadata of the content instance.
Copyright information.
Get the crossOrigin policy to use for img, video and audio tags on the current site.
URL to the source
crossOrigin attribute value required by the source
Use getCrossOrigin with the source as a H5PMedia instead
Get the crossOrigin policy to use for img, video and audio tags on the current site.
If the source points to external media, or H5PIntegration.crossorigin has a falsy value,
undefined will be returned.
File object from parameters/json_content
crossOrigin attribute value required by the source
Find the path to the content files based on the id of the content. Also identifies and returns absolute paths
Relative to content folder or absolute
ID of the content requesting the path
Complete URL to path
Private getPrivate Get user data for given content
What content to get data for
Identifies the set of data for this content
Callback with error and data parameters
Optional subContentId: H5PContentIdIdentifies which data belongs to sub content
Initialize H5P content. Scans for ".h5p-content" in the document and initializes H5P instances where found.
DOM Element
next version after 1.24.4 (not released as of 2023-12-26)
Recursive function that detects deep empty structures.
Will return true if the value is null, undefined, an empty string, an empty array or an empty object.
Will also return true if the value is an array or object that contains only empty values.
// True for all of:
H5P.isEmpty({});
H5P.isEmpty([]);
H5P.isEmpty("");
H5P.isEmpty(null);
H5P.isEmpty(undefined);
H5P.isEmpty({ a: "" });
H5P.isEmpty({ a: ["", [], {}] });
H5P.isEmpty({ a: {} });
H5P.isEmpty({ a: { b: "" } });
Parse library string into values.
library in the format "machineName majorVersion.minorVersion"
library as an object with machineName, majorVersion and minorVersion properties, or false if the library parameter is invalid
A safe way of creating a new instance of a runnable H5P.
Library/action object form params.
Identifies the content.
Optional $attachTo: JQuery<HTMLElement>Element to attach the instance to.
Optional skipResize: booleanSkip triggering of the resize event after attaching.
Optional extras: H5PExtrasWithState<TState>Extra parameters for the H5P content constructor
Instance
Display a dialog containing the embed code
Element to insert dialog after
The embed code
The advanced resize code
The content's size
Display a dialog containing the download button and copy button
Enter semi fullscreen for the given H5P instance
Content container.
Callback function called when user exits fullscreen.
For internal use. Gives the body of the iframe.
Set item in the H5P Clipboard
Data to be set
Post finished results for user
Identifies the content
Achieved score/points
The maximum score/points that can be achieved
Optional time: numberReported time consumption/usage
Do not use this function directly, trigger the finish event instead
Helper for setting the crossOrigin attribute + the complete correct source. Note: This will start loading the resource.
Runs getPath internally.
DOM element, typically img, video or audio
Uploaded file object from parameters/json_content (created by H5PEditor)
Needed to determine the complete correct file path
const imageElement = document.createElement("img");
const image = {
path: "path/to/image.png",
};
const contentId = "1";
H5P.setSource(imageElement, image, contentId);
// imageElement.src === "https://example.com/path/to/image.png"
Private setPrivate Set user data for given content
What content to get data for
Identifies the set of data for this content
The data that is to be stored
Optional extras: { Extra properties
Optional async?: booleanDefault: true
Optional deleteIf the data should be invalidated when the content changes. Default: false
Optional preloaded?: booleanIf the data should be loaded when content is loaded. Default: true
Optional subIdentifies which data belongs to sub content
Callback with error as parameters
Shuffle an array in place
Use Array#sort instead
Translate text strings.
Translation identifier, may only contain a-zA-Z0-9. No spaces or special chars.
Optional placeholderVars: Record<string, string>Data for placeholders.
Optional namespace: stringTranslation namespace. Defaults to H5P.
Translated text
Trigger an event on an instance
Helper function that triggers an event if the instance supports event handling
Instance of H5P content
Type of event to trigger
Remove all empty spaces before and after the value
Use String#trim instead
This is an interface which represents the
window.H5P, or simplyH5P, object in the H5P Core library. The object works as a namespace for a lot of utilities and classes that are used when creating both widgets and content types in H5P.