@base-framework/base 3.0.118 → 3.0.120

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.
@@ -1,9 +1,14 @@
1
1
  /**
2
- * Class representing an animation.
2
+ * Animation
3
+ *
4
+ * This will setup the animation.
5
+ *
6
+ * @class
3
7
  */
4
8
  export class Animation {
5
9
  /**
6
10
  * Create an animation.
11
+ *
7
12
  * @param {HTMLElement} element - The element to animate.
8
13
  * @param {Object} settings - The settings for the animation.
9
14
  */
@@ -12,17 +17,23 @@ export class Animation {
12
17
  movements: any[];
13
18
  /**
14
19
  * Setup the animation with the given settings.
20
+ *
15
21
  * @param {Object} settings - The settings for the animation.
22
+ * @returns {void}
16
23
  */
17
24
  setup(settings: any): void;
18
25
  /**
19
26
  * Add a movement to the animation.
27
+ *
20
28
  * @param {Object} property - The property to animate.
29
+ * @returns {void}
21
30
  */
22
31
  addMovement(property: any): void;
23
32
  /**
24
33
  * Setup the movements for the animation.
34
+ *
25
35
  * @param {Object} settings - The settings for the animation.
36
+ * @returns {void}
26
37
  */
27
38
  setupMovements(settings: any): void;
28
39
  }
@@ -1,5 +1,39 @@
1
+ /**
2
+ * AttrMovement
3
+ *
4
+ * This will animate an attribute.
5
+ *
6
+ * @class
7
+ */
1
8
  export class AttrMovement extends Movement {
9
+ /**
10
+ * Create an attribute movement.
11
+ *
12
+ * @param {object} element - The element to animate.
13
+ * @param {object} settings - The settings
14
+ */
15
+ constructor(element: object, settings: object);
2
16
  filter: any;
17
+ /**
18
+ * This will get the value of the element property.
19
+ *
20
+ * @param {*} value - The value to get.
21
+ * @param {*} end - The end value.
22
+ * @returns {*} The value.
23
+ */
24
+ getStartValue(value: any, end: any): any;
25
+ /**
26
+ * This will get the value of the element property.
27
+ *
28
+ * @param {*} value - The value to get.
29
+ * @returns {*} The value.
30
+ */
3
31
  filterValue(value: any, ...args: any[]): any;
32
+ /**
33
+ * This will update the value of the element property.
34
+ *
35
+ * @param {*} value
36
+ */
37
+ update(value: any): void;
4
38
  }
5
39
  import { Movement } from './movement.js';
@@ -0,0 +1,4 @@
1
+ export function DefaultProps(): object;
2
+ export function StringProp(value: string): object;
3
+ export function ArrayProp(value: any[]): object;
4
+ export function ObjectProp(args: any[]): object;
@@ -2,6 +2,7 @@
2
2
  * HistoryController
3
3
  *
4
4
  * This will setup the history controller.
5
+ *
5
6
  * @class
6
7
  */
7
8
  export class HistoryController {
@@ -1,9 +1,8 @@
1
- export namespace Utils {
2
- /**
3
- * This will remove the begining and ending slashes from a url.
4
- *
5
- * @param {string} uri
6
- * @returns {string}
7
- */
8
- function removeSlashes(uri: string): string;
9
- }
1
+ /**
2
+ * Utils
3
+ *
4
+ * These are some helper functions for the router.
5
+ *
6
+ * @type {object} Utils
7
+ */
8
+ export const Utils: object;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base-framework/base",
3
- "version": "3.0.118",
3
+ "version": "3.0.120",
4
4
  "description": "This is a javascript framework.",
5
5
  "main": "./dist/base.js",
6
6
  "type": "module",