powerpagestoolkit 2.7.121-2.1 → 2.7.121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -35,7 +35,7 @@ createRef(
|
|
|
35
35
|
options: {
|
|
36
36
|
multiple: (() => boolean) | boolean = false,
|
|
37
37
|
root: HTMLElement,
|
|
38
|
-
|
|
38
|
+
timeout: number
|
|
39
39
|
}
|
|
40
40
|
): Promise<DOMNodeReference | DOMNodeReference[]>;
|
|
41
41
|
```
|
|
@@ -66,7 +66,7 @@ createRef takes two main arguments:
|
|
|
66
66
|
<pre><code class="language-javascript">{
|
|
67
67
|
multiple: () => boolean | boolean,
|
|
68
68
|
root: HTMLElement,
|
|
69
|
-
|
|
69
|
+
timeout: number
|
|
70
70
|
}</code></pre>
|
|
71
71
|
</td>
|
|
72
72
|
<td style="border: 1px solid #ddd; padding: 8px;">
|
|
@@ -98,7 +98,7 @@ const nodes = await createRef(".my-class", { multiple: true });
|
|
|
98
98
|
|
|
99
99
|
// If the node you are targeting is not available at the initial execution
|
|
100
100
|
// of the script, set a timeout for 2 seconds
|
|
101
|
-
const node2 = await createRef("#target", {
|
|
101
|
+
const node2 = await createRef("#target", { timeout: 2000 });
|
|
102
102
|
|
|
103
103
|
// need to target a node within a specific node? use that node as the root
|
|
104
104
|
const otherElement = document.getElementById("id");
|
|
@@ -107,7 +107,7 @@ const node3 = await createRef("#target", { root: otherElement });
|
|
|
107
107
|
// implement all options:
|
|
108
108
|
const nodes2 = await createRef("#target", {
|
|
109
109
|
multiple: true,
|
|
110
|
-
|
|
110
|
+
timeout: 4000,
|
|
111
111
|
root: otherElement,
|
|
112
112
|
});
|
|
113
113
|
```
|
package/dist/bundle.js
CHANGED
|
@@ -102,11 +102,11 @@ var API = {
|
|
|
102
102
|
};
|
|
103
103
|
var API_default = API;
|
|
104
104
|
|
|
105
|
-
// src/
|
|
105
|
+
// src/utils/waitFor.ts
|
|
106
106
|
function waitFor(target, root = document, multiple = false, debounceTime2) {
|
|
107
107
|
return new Promise((resolve, reject) => {
|
|
108
108
|
if (multiple) {
|
|
109
|
-
let
|
|
109
|
+
let timeout;
|
|
110
110
|
const observedElements = [];
|
|
111
111
|
const observedSet = /* @__PURE__ */ new Set();
|
|
112
112
|
if (debounceTime2 < 1) {
|
|
@@ -122,8 +122,8 @@ function waitFor(target, root = document, multiple = false, debounceTime2) {
|
|
|
122
122
|
observedElements.push(element);
|
|
123
123
|
}
|
|
124
124
|
});
|
|
125
|
-
clearTimeout(
|
|
126
|
-
|
|
125
|
+
clearTimeout(timeout);
|
|
126
|
+
timeout = setTimeout(() => {
|
|
127
127
|
if (observedElements.length > 0) {
|
|
128
128
|
observer.disconnect();
|
|
129
129
|
resolve(observedElements);
|
|
@@ -1,31 +1,4 @@
|
|
|
1
1
|
import * as s from "@/constants/symbols.js";
|
|
2
|
-
declare type BusinessRule = {
|
|
3
|
-
/**
|
|
4
|
-
* @param condition A function that returns a boolean to determine
|
|
5
|
-
* the visibility of the target element. If `condition()` returns true, the element is shown;
|
|
6
|
-
* otherwise, it is hidden.
|
|
7
|
-
|
|
8
|
-
* @param clearValuesOnHide Should the values in the targeted field be cleared when hidden? Defaults to true
|
|
9
|
-
*/
|
|
10
|
-
setVisibility?: [condition: () => boolean, clearValuesOnHide?: boolean];
|
|
11
|
-
/**
|
|
12
|
-
* @param isRequired Function determining if field is required
|
|
13
|
-
* @param isValid Function validating field input.
|
|
14
|
-
*/
|
|
15
|
-
setRequired?: [isRequired: () => boolean, isValid: () => boolean];
|
|
16
|
-
/**
|
|
17
|
-
* @param condition A function to determine if the value provided should be applied to this field
|
|
18
|
-
* @param value The value to set for the HTML element.
|
|
19
|
-
* for parents of boolean radios, pass true or false as value, or
|
|
20
|
-
* an expression returning a boolean
|
|
21
|
-
*/
|
|
22
|
-
setValue?: [condition: () => boolean, value: () => any | any];
|
|
23
|
-
/**
|
|
24
|
-
* @param condition A function to determine if this field
|
|
25
|
-
* should be enabled in a form, or disabled. True || 1 = disabled. False || 0 = enabled
|
|
26
|
-
*/
|
|
27
|
-
setDisabled?: () => boolean;
|
|
28
|
-
};
|
|
29
2
|
export default class DOMNodeReference {
|
|
30
3
|
target: Element | string;
|
|
31
4
|
logicalName?: string;
|
|
@@ -278,4 +251,3 @@ export default class DOMNodeReference {
|
|
|
278
251
|
*/
|
|
279
252
|
onceLoaded(callback: (instance: DOMNodeReference) => any): any;
|
|
280
253
|
}
|
|
281
|
-
export {};
|
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
import DOMNodeReference from "./DOMNodeReference.js";
|
|
2
2
|
import DOMNodeReferenceArray from "./DOMNodeReferenceArray.js";
|
|
3
|
-
declare type BoundForm = DOMNodeReferenceArray & Record<string, DOMNodeReference>;
|
|
4
3
|
/**
|
|
5
4
|
* Get all controls related to the form for manipulating with the
|
|
6
5
|
* DOMNodeReference class. Rather than having to instantiate each fields that you need manually,
|
|
7
6
|
* you can call this method once with the form ID and gain access to all fields
|
|
8
7
|
* @param formId The string GUID of the form you want to bind to
|
|
9
|
-
* @returns An array of DOMNodeReferences
|
|
10
|
-
* @see {@link BoundForm}
|
|
8
|
+
* @returns An array of DOMNodeReferences
|
|
11
9
|
*/
|
|
12
|
-
export default function bindForm(formId: string): Promise<
|
|
13
|
-
export {};
|
|
10
|
+
export default function bindForm<T extends string>(formId: string): Promise<DOMNodeReferenceArray & Record<T, DOMNodeReference>>;
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import "./style.css";
|
|
2
2
|
import API from "./core/API.js";
|
|
3
3
|
import createRef from "./core/createDOMNodeReferences.js";
|
|
4
|
-
import waitFor from "./
|
|
4
|
+
import waitFor from "./utils/waitFor.js";
|
|
5
5
|
import bindForm from "./core/bindForm.js";
|
|
6
6
|
export { API, createRef, waitFor, bindForm };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "powerpagestoolkit",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.121",
|
|
4
4
|
"description": "Reference, manipulate, and engage with Power Pages sites through the nodes in the DOM; use a variety of custom methods that allow customizing your power pages site quicker and easier. ",
|
|
5
5
|
"main": "./dist/bundle.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
File without changes
|