NeedsExamples

gadgets.util

Provides general-purpose utility functions.

Methods

gadgets.util.escapeString

;<static> String gadgets.util.escapeString(str)

Parameters
NameTypeDescription |

str

String

The string to escape

Returns
TypeDescription |

String

The escaped string

Description
Escapes the input using HTML entities to make it safer. The following characters are affected: newline (\n, Unicode code point 10) carriage return (\r, Unicode 13) double quote (", Unicode 34) ampersand (&, Unicode 38) single quote (', Unicode 39) left angle bracket (<, Unicode 60) right angle bracket (>, Unicode 62) backslash (\, Unicode 92) line separator (Unicode 8232) paragraph separator (Unicode 8233)

gadgets.util.getFeatureParameters

;<static> Object gadgets.util.getFeatureParameters(feature)

Parameters
NameTypeDescription |

feature

String

The feature to get parameters for

Returns
TypeDescription |

Object

The parameters for the given feature, or null

Description
Returns the value of parameters for this feature. A gadget specifies parameters using the <Param> subelement of the <Requires> or <Optional> element.

gadgets.util.hasFeature

;<static> Boolean gadgets.util.hasFeature(feature)

Parameters
NameTypeDescription |

feature

String

The feature to test for

Returns
TypeDescription |

Boolean

True if the feature is supported

Description
Returns whether the specified feature is supported.

gadgets.util.registerOnLoadHandler

;<static> gadgets.util.registerOnLoadHandler(callback)

Parameters
NameTypeDescription |

callback

Function

The handler to run. The callback function will not be called until after the existing callstack has completed execution.

Description
Registers an onload handler; a function that's executed when the gadget loads. Multiple handlers can be registered, and all will be invoked in the same order that they were registered.

gadgets.util.sanitizeHtml

;<static> String gadgets.util.sanitizeHtml(text)

Parameters
NameTypeDescription |

text

String

arbitrary text string

Returns
TypeDescription |

String

a sanitized version that may include HTML tags, but will not execute script.

Description
Sanitizes a text string. The returned value is safe to assign to innerHTML. The returned value may include HTML tags. If plain text is desired, use gadgets.util.escapeString instead.

gadgets.util.unescapeString

;<static> String gadgets.util.unescapeString(str)

Parameters
NameTypeDescription |

str

String

The string to unescape.

Returns
TypeDescription |

String

The unescaped string

Description
Reverses escapeString