Utility functions
A collection of helper functions that can be imported by name from attractions/utils. For example: import { classes } from 'attractions/utils';
Name | Signature | Description |
|---|---|---|
callOnSight | (node, { callback, args }) => { destroy } | An action that is intended to be used with the use directive. Calls the provided callback with the given args (spreaded) once the component appears on the screen. |
classes | (...args) => string | Filters the falsey values from the given arguments and concatenates the rest in one string. |
getColorPickerStyles | (hexColor: string) => string | Returns the styles needed for displaying a radiobutton or a checkbox with the given color. |
dynamicTransition | (node, { transition, options }) => Transition | Create a transition that allows specifying a transition programmatically or disable it altogether. To be used with the transition directive. |
escapeRegExp | (string: string) => string | A small function to escape the regexp characters in a string. Taken from MDN. |
events | (node, args: {name, handler}[]) => { destroy } | An action to set up arbitrary event listeners dynamically. Can be used to define multiple handlers for the same event. |
formatFileSize | (bytes: number) => string | Format the file size in bytes to a human-readable format. |
formatFileType | (filename: string) => string | Format the file type from the extension. |
s | (amount: number) => string | Returns an 's' character to use for pluralization if the amount is not one. |
range | (start, end, step) => Generator<number> | Generates a (Python-like) semi-open range. |
ripple | (node, options) => { destroy, update } | An action that adds a ripple effect to the component on the specified event. Possible options are:
|