Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 | 94x 94x 94x 94x 94x 94x 94x 94x 94x 94x 94x 94x 94x 94x 335x 328x 328x 328x 206x 206x 328x 328x 328x 328x 328x 328x 91x 87x 87x 87x 25x 328x 23x 19x 19x 19x 3x 328x 8x 8x 328x 328x 686x 328x 69x 63x 63x 63x 63x 63x 59x 63x 63x 63x 63x 36x 36x 31x 31x 69x 375x 328x 328x 94x 3313x 847x 2466x 2466x 2466x 2466x 2466x 2466x 122x 122x 122x 122x 122x 124x 124x 120x 120x 118x 118x 9x 10x 94x 268x 268x 263x 268x 1699x 264x 94x 160x 160x 160x 901x 160x 94x 122x 122x 122x 122x 109x 13x 3x 13x 10x 122x 94x 1908x 94x 30x 30x 23x 23x 23x 6x 6x 24x 94x 94x 192x 94x 94x 263x 263x 248x 248x 248x 263x | /**
* ## Specification for the HTML API for widgets
*
* The following describes the general syntax when using the HTML API for
* automatic creation of widgets based on data attributes
* {@link Settings.settings.autoWidgets | settings.autoWidgets} must be true.
*
* A widget specification should be given as a
* `data-lisn-<WidgetName>="<WidgetConfList>"` attribute.
*
* Alternatively, if using all default configurations, you can simply add the
* `lisn-<WidgetName>` CSS class. Specifying a configuration using CSS classes
* is not currently possible for widgets, only for triggers (though it's
* discouraged).
*
* The general specification for a widget is of the form:
*
* ```
* <WidgetConfList> ::= <WidgetConf> { ";" <WidgetConf> }
*
* <WidgetConf> ::= [ <WidgetOption> { "|" <WidgetOption> } ]
*
* <WidgetOption> ::=
* <BooleanOptionName> [ "=" ( "false" | "true" ) ] |
* <OptionName> "=" <OptionValue>
* ```
*
* **NOTE:**
*
* There can be 0 or more spaces around any of the separator characters.
*
* Not all widgets support multiple instances per single element and therefore
* multiple configurations. Refer to each specific widget.
*
* The characters `|`, `;`, `=` are reserved separators and cannot be used
* literally as part of an option value.
*
* See documentation on a specific widget for examples.
*
* @module Widgets
*/
import * as MC from "@lisn/globals/minification-constants";
import * as MH from "@lisn/globals/minification-helpers";
import { settings } from "@lisn/globals/settings";
import { hasClass, getData } from "@lisn/utils/css-alter";
import { waitForInteractive } from "@lisn/utils/dom-events";
import { logWarn } from "@lisn/utils/log";
import { toArrayIfSingle } from "@lisn/utils/misc";
import { waitForDelay } from "@lisn/utils/tasks";
import { formatAsString, kebabToCamelCase, splitOn } from "@lisn/utils/text";
import {
CallbackHandler,
Callback,
wrapCallback,
} from "@lisn/modules/callback";
import { newXWeakMap } from "@lisn/modules/x-map";
import { DOMWatcher } from "@lisn/watchers/dom-watcher";
import debug from "@lisn/debug/debug";
export class Widget {
/**
* Disables the functionality of the widget. What this means is specific to
* each widget.
*/
readonly disable: () => Promise<void>;
/**
* Re-enables the functionality of the widget. What this means is specific to
* each widget.
*/
readonly enable: () => Promise<void>;
/**
* Re-enables the widget if disabled, otherwise disables it.
*/
readonly toggleEnable: () => Promise<void>;
/**
* The given handler will be called when the widget is disabled.
*/
readonly onDisable: (handler: WidgetHandler) => void;
/**
* The given handler will be called when the widget is enabled.
*/
readonly onEnable: (handler: WidgetHandler) => void;
/**
* Returns true if the widget is currently disabled.
*/
readonly isDisabled: () => boolean;
/**
* Undoes all modifications to the element and returns it to its original state.
*
* You will need to recreate it if you want to enable its functionality again.
*/
readonly destroy: () => Promise<void>;
/**
* The given handler will be called when the widget is destroyed.
*/
readonly onDestroy: (handler: WidgetHandler) => void;
/**
* Returns true if the widget is destroyed.
*/
readonly isDestroyed: () => boolean;
/**
* Returns the element passed to the widget constructor.
*/
readonly getElement: () => Element;
/**
* Retrieve an existing widget by element and ID.
*/
static get(element: Element, id: string): Widget | null {
return instances.get(element)?.get(id) ?? null;
}
/**
* **IMPORTANT:** If ID is given and there's already a widget with this ID on
* this element, it will be destroyed!
*/
constructor(element: Element, config?: { id?: string }) {
const logger = debug
? new debug.Logger({
name: `${this.constructor.name}-${formatAsString(element)}`,
logAtCreation: this,
})
: null;
const id = config?.id;
if (id) {
instances.get(element)?.get(id)?.destroy(); // don't await here
instances.sGet(element).set(id, this);
}
let isDisabled = false;
let isDestroyed = false;
let destroyPromise: Promise<void>;
const enableCallbacks = MH.newSet<WidgetCallback>();
const disableCallbacks = MH.newSet<WidgetCallback>();
const destroyCallbacks = MH.newSet<WidgetCallback>();
this.disable = async () => {
if (!isDisabled) {
debug: logger?.debug8("Disabling");
isDisabled = true;
for (const callback of disableCallbacks) {
await callback.invoke(this);
}
}
};
this.enable = async () => {
if (!isDestroyed && isDisabled) {
debug: logger?.debug8("Enabling");
isDisabled = false;
for (const callback of enableCallbacks) {
await callback.invoke(this);
}
}
};
this.toggleEnable = async () => {
if (!isDestroyed) {
await (isDisabled ? this.enable : this.disable)();
}
};
this.onDisable = (handler) => disableCallbacks.add(wrapCallback(handler));
this.onEnable = (handler) => enableCallbacks.add(wrapCallback(handler));
this.isDisabled = () => isDisabled;
this.destroy = () => {
if (!destroyPromise) {
destroyPromise = (async () => {
debug: logger?.debug8("Destroying");
isDestroyed = true;
await this.disable();
for (const callback of destroyCallbacks) {
await callback.invoke(this);
}
enableCallbacks.clear();
disableCallbacks.clear();
destroyCallbacks.clear();
if (id) {
const elInstances = instances.get(element);
if (elInstances?.get(id) === this) {
MH.deleteKey(elInstances, id);
instances.prune(element);
}
}
})();
}
return destroyPromise;
};
this.onDestroy = (handler) => destroyCallbacks.add(wrapCallback(handler));
this.isDestroyed = () => isDestroyed;
this.getElement = () => element;
}
}
export type WidgetCallbackArgs = [Widget];
export type WidgetCallback = Callback<WidgetCallbackArgs>;
export type WidgetHandler =
| WidgetCallback
| CallbackHandler<WidgetCallbackArgs>;
/**
* **NOTE:** If the function returns a widget or a list of widgets created for
* the given element, then each one will be automatically destroyed if the
* element is removed from the DOM.
*/
export type WidgetCreateFn<Config extends Record<string, unknown>> = (
element: Element,
config?: Config,
) => Widget | Widget[] | null | Promise<Widget | Widget[] | null>;
/**
* @see {@link getWidgetConfig}.
*/
export type WidgetConfigValidatorObject<
Config extends Record<string, unknown>,
> = {
[K in keyof Config]: (key: K, v: unknown) => Config[K];
};
/**
* @see {@link getWidgetConfig}.
*/
export type WidgetConfigAsyncValidatorObject<
Config extends Record<string, unknown>,
> = {
[K in keyof Config]: (key: K, v: unknown) => Config[K] | Promise<Config[K]>;
};
/**
* @see {@link getWidgetConfig}.
*/
export type WidgetConfigValidatorFunc<Config extends Record<string, unknown>> =
(
element: Element,
) =>
| WidgetConfigValidatorObject<Config>
| WidgetConfigAsyncValidatorObject<Config>;
/**
* @see {@link getWidgetConfig}.
*/
export type WidgetConfigValidator<Config extends Record<string, unknown>> =
| WidgetConfigValidatorObject<Config>
| WidgetConfigValidatorFunc<Config>;
/**
* Enables automatic setting up of a widget from an elements matching the given
* selector.
*
* If {@link settings.autoWidgets} is true, nothing is done. Otherwise,
* when an element matching the selector is added to the DOM, `newWidget` will
* be called and it's expected to setup the widget.
*
* **IMPORTANT:** The widget that is returned by `newWidget` will be
* automatically destroyed when the element that created them is removed from
* the DOM.
*
* **IMPORTANT:** If a widget by that name is already registered, the current
* call does nothing, even if the remaining arguments differ.
*
* @param name The name of the widget. Should be in kebab-case.
* @param newWidget Called for every element matching the widget selector.
* @param configValidator
* A validator object, or a function that returns such an
* object, for all options supported by the widget. If
* given, then the `newWidget` function will also be
* passed a configuration object constructed from the
* element's data attribute. The widget's configuration is read
* from the `data-lisn-<name>` attribute.
* @param [options.selector]
* The selector to match elements for. If not given, then
* uses a default value of `[data-lisn-<name>], .lisn-<name>`
* @param [options.supportsMultiple]
* If true, and if `configValidator` is given, then the
* value of the element's widget specific data attribute
* will be split on `;` and each one parsed individually
* as a configuration. Then the `newWidget` function will
* be called once for each configuration.
*/
export const registerWidget = async <Config extends Record<string, unknown>>(
name: string,
newWidget: WidgetCreateFn<Config>,
configValidator?: null | WidgetConfigValidator<Config>,
options?: {
selector?: string;
supportsMultiple?: boolean;
// TODO options for separators
},
) => {
if (registeredWidgets.has(name)) {
return;
}
registeredWidgets.add(name);
// init after DOM loaded so that the settings can be configured by the user
// straight after loading LISN.js
await waitForInteractive();
const selector =
options?.selector || getDefaultWidgetSelector(MH.prefixName(name));
if (settings.autoWidgets) {
const domWatcher = DOMWatcher.reuse();
domWatcher.onMutation(
async (operation) => {
const element = MH.currentTargetOf(operation);
const thisConfigValidator = MH.isFunction(configValidator)
? await configValidator(element)
: configValidator;
const widgets: Widget[] = [];
const configSpecs = getDataAttrConfigSpecs(
name,
element,
options?.supportsMultiple ? CONFIG_SEP_CHAR : null,
);
for (const spec of configSpecs) {
const config = thisConfigValidator
? await fetchWidgetConfig(spec, thisConfigValidator)
: undefined;
const theseWidgets = await newWidget(element, config);
if (theseWidgets) {
widgets.push(...toArrayIfSingle(theseWidgets));
}
}
// auto-destroy on element remove
if (MH.lengthOf(widgets)) {
domWatcher.onMutation(
() => {
for (const w of widgets) {
w.destroy();
}
},
{
target: element,
categories: [MC.S_REMOVED],
},
);
}
},
{
selector,
categories: [MC.S_ADDED],
},
);
}
};
/**
* Returns a configuration object from the given user input, which can be
* either an object or a `<separator>` separated string of key=values.
*
* If `input` is a string, it must be of the format:
*
* ```
* <UserConfigString> ::= <OptionSpec> { <Separator> <OptionSpec> }
*
* <OptionSpec> ::=
* <BooleanOptionName> [ "=" ( "false" | "true" ) ] |
* <OptionName> "=" <OptionValue>
* ```
*
* By default, for widgets `<separator>` is `|`.
*
* **NOTE:** If `input` is a string, option names will be converted from
* kebab-case to camelCase.
*
* The given `validator` defines the shape of the returned object. It is called
* for each entry _in the `validator` object_, with that key and the
* corresponding value from the input configuration, as the two parameters.
*
* If a key is not found in the input, the value passed to the validating
* function will be `undefined`.
*
* If the input is a string and a key has no value, the value passed to the
* validating function will be an empty string `""`.
*
* The final configuration contains all keys from the `validator` object with
* the value that the validating function for each key returned.
*
* There are several built-in validating functions that you can make use of:
* - {@link Utils.validateStrList}
* - {@link Utils.validateNumList}
* - {@link Utils.validateNumber}
* - {@link Utils.validateBoolean}
* - {@link Utils.validateString}
* - {@link Utils.validateStringRequired}
* - {@link Utils.validateBooleanOrString}
*/
export const getWidgetConfig = <Config extends Record<string, unknown>>(
input: Record<string, unknown> | string | null | undefined,
validator: WidgetConfigValidatorObject<Config>,
separator = OPT_SEP_CHAR,
): Config => {
const config = {} as Config;
if (!(input instanceof Object)) {
input = toOptionsObject(input, separator);
}
for (const key in validator) {
config[key] = validator[key](key, input[key]);
}
return config;
};
/**
* Like {@link getWidgetConfig} but it accepts an object whose validator
* functions may return a promise.
*/
export const fetchWidgetConfig = async <Config extends Record<string, unknown>>(
input: Record<string, unknown> | string | null | undefined,
validator: WidgetConfigAsyncValidatorObject<Config>,
separator = OPT_SEP_CHAR,
): Promise<Config> => {
const config = {} as Config;
const configPromises = getWidgetConfig<{
[K in keyof Config]: Config[K] | Promise<Config[K]>;
}>(input, validator, separator);
for (const key in configPromises) {
config[key] = await configPromises[key];
}
return config;
};
/**
* @ignore
* @internal
*/
export const getDataAttrConfigSpecs = (
name: string,
element: Element,
separator?: null | string, // If given, it will split input
) => {
const prefixedName = MH.prefixName(name);
const configSpecs: string[] = [];
const dataAttr = getData(element, prefixedName);
if (MH.isNullish(separator)) {
// Does not support multiple configs
configSpecs.push(dataAttr ?? "");
} else {
if (hasClass(element, prefixedName)) {
configSpecs.push("");
}
if (dataAttr !== null) {
configSpecs.push(
...(dataAttr ? splitOn(dataAttr, CONFIG_SEP_CHAR, true) : [""]),
);
}
}
return configSpecs;
};
/**
* @ignore
* @internal
*/
export const getDefaultWidgetSelector = (prefix: string) =>
`.${prefix},[data-${prefix}]`;
/**
* @ignore
* @internal
*/
export const fetchUniqueWidget = async <W extends Widget>(
name: string,
element: Element,
Type: { get: (element: Element) => W | null },
): Promise<W | null> => {
let widget = Type.get(element);
if (!widget) {
await waitForDelay(0); // in case it's being processed now
widget = Type.get(element);
if (!widget) {
logWarn(`No ${name} widget for element ${formatAsString(element)}`);
return null;
}
}
return widget;
};
// --------------------
const CONFIG_SEP_CHAR = ";";
const OPT_SEP_CHAR = "|";
const instances = newXWeakMap<Element, Map<string, Widget>>(() => MH.newMap());
const registeredWidgets = MH.newSet<string>();
const toOptionsObject = (
input: string | null | undefined,
separator: string,
) => {
const options: Record<string, string> = {};
for (const entry of MH.filter(
splitOn(input ?? "", separator, true),
(v) => !MH.isEmpty(v),
)) {
const [key, value] = splitOn(entry, /\s*=\s*/, true, 1);
options[kebabToCamelCase(key)] = value ?? "";
}
return options;
};
|