Function

The abbreviateNumber utility converts a number to a shorter localized form.

Shows an alert if the user has not yet confirmed their email address.

The anchorScroll utility saves the scroll position relative to an element, and then restores it after a callback has been run.

This is useful if a redraw will change the page's content above the viewport. Normally doing this will result in the content in the viewport being pushed down or pulled up. By wrapping the redraw with this utility, the scroll position can be anchor to an element that is in or below the viewport, so the content in the viewport will stay the same.

The avatar helper displays a user's avatar.

The computed utility creates a function that will cache its output until any of the dependent values are dirty.

Escapes the RegExp special characters in input.

Extend an object's method by running its output through a mutating callback every time it is called.

The callback accepts the method's return value and should perform any mutations directly on this value. For this reason, this function will not be effective on methods which return scalar values (numbers, strings, booleans).

Care should be taken to extend the correct object – in most cases, a class' prototype will be the desired target of extension, not the class itself.

Example:

extend(Discussion.prototype, 'badges', function(badges) {
  // do something with `badges`
});

extend(IndexPage.prototype, ['oncreate', 'onupdate'], function(vnode) {
  // something that needs to be run on creation and update
});

The extract utility deletes a property from an object and returns its value.

Extract the text nodes from a virtual element.

Calls console.warn with the provided arguments, but only if the forum is in debug mode.

This function is intended to provide warnings to extension developers about issues with their extensions that may not be easily noticed when testing, such as accessibility issues.

These warnings should be hidden on production forums to ensure webmasters are not inundated with do-gooders telling them they have an issue when it isn't something they can fix.

The formatNumber utility localizes a number into a string with the appropriate punctuation.

The fullTime helper displays a formatted time string wrapped in a <time> tag.

Strip HTML tags and quotes out of the given string, replacing them with meaningful punctuation.

The highlight helper searches for a word phrase in a string, and wraps matches with the <mark> tag.

The humanTime utility converts a date to a localized, human-readable time- ago string.

The humanTime helper displays a time in a human-friendly time-ago format (e.g. '12 days ago'), wrapped in a <time> tag with other information about the time.

The icon helper displays an icon.

See:

• https://stackoverflow.com/a/31732310

The listItems helper wraps a collection of components in

The liveHumanTimes initializer sets up a loop every 1 second to update timestamps rendered with the humanTime helper.

The mapRoutes utility converts a map of named application routes into a format that can be understood by Mithril, and wraps them in route resolvers to provide each route with the current route name.

See:

• https://mithril.js.org/route.html#signature

The mixin utility assigns the properties of a set of 'mixin' objects to the prototype of a parent object.

Example:

class MyClass extends mixin(ExistingClass, evented, etc) {}

Override an object's method by replacing it with a new function, so that the new function will be run every time the object's method is called.

The replacement function accepts the original method as its first argument, which is like a call to super. Any arguments passed to the original method are also passed to the replacement.

Care should be taken to extend the correct object – in most cases, a class' prototype will be the desired target of extension, not the class itself.

Example:

override(Discussion.prototype, 'badges', function(original) {
  const badges = original();
  // do something with badges
  return badges;
});

extend(Discussion.prototype, ['oncreate', 'onupdate'], function(original, vnode) {
  // something that needs to be run on creation and update
});

The punctuateSeries helper formats a list of strings (e.g. names) to read fluently in the application's locale.

punctuateSeries(['Toby', 'Franz', 'Dominion']) // Toby, Franz, and Dominion

The routes initializer defines the forum app's routes.

The routes initializer defines the forum app's routes.

Mithril 2 does not completely rerender the page if a route change leads to the same route (or the same component handling a different route). This util calls m.route.set, forcing a reonit.

The slidable utility adds touch gestures to an element so that it can be slid away to reveal controls underneath, and then released to activate those controls.

It relies on the element having children with particular CSS classes. TODO: document

Create a slug out of the given string. Non-alphanumeric characters are converted to hyphens.

NOTE: This method does not use the comparably sophisticated transliteration mechanism that is employed in the backend. Therefore, it should only be used to suggest slugs that can be overridden by the user.

Convert the given string to a unique color.

Check if class A is the same as or a subclass of class B.

Truncate a string to the given length, appending ellipses if necessary.

Make a string's first character uppercase.

The useronline helper displays a green circle if the user is online

The username helper displays a user's username in a tag. If the user doesn't exist, the username will be displayed as [deleted].

An event handler factory that makes it simpler to implement data binding for component event listeners.

The handler created by this factory passes the DOM element's attribute identified by the first argument to the callback (usually a bidirectional Mithril stream: https://mithril.js.org/stream.html#bidirectional-bindings).

Replaces m.withAttr for Mithril 2.0.

See:

• https://mithril.js.org/archive/v0.2.5/mithril.withAttr.html