@salesforcedevs/docs-components 1.3.177 → 1.3.179

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforcedevs/docs-components",
3
- "version": "1.3.177",
3
+ "version": "1.3.179",
4
4
  "description": "Docs Lightning web components for DSC",
5
5
  "license": "MIT",
6
6
  "main": "index.js",
@@ -24,5 +24,5 @@
24
24
  "@types/lodash.orderby": "^4.6.7",
25
25
  "@types/lodash.uniqby": "^4.7.7"
26
26
  },
27
- "gitHead": "fd34f6d2447461ef0dd93045c8df04cf090b97f2"
27
+ "gitHead": "ef5efd7169e688009ba79bd74e69c42adb277e09"
28
28
  }
@@ -12,11 +12,11 @@ import {
12
12
  PageReference,
13
13
  TocMap
14
14
  } from "./types";
15
- import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
15
+ import { SearchSyncer } from "docUtils/searchSyncer";
16
+ import { LightningElementWithState } from "dxBaseElements/lightningElementWithState";
16
17
  import { oldVersionDocInfo } from "docUtils/utils";
17
18
  import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
18
19
  import { track as trackGTM } from "dxUtils/analytics";
19
- import { SearchSyncer } from "docUtils/searchSyncer";
20
20
 
21
21
  // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
22
22
  const handleContentError = (error: any): void => console.log(error);
@@ -1,93 +0,0 @@
1
- import { LightningElement, track } from "lwc";
2
-
3
- /**
4
- * This is a helper class for when you want your LWC component to have state
5
- * that is automatically tracked _along with_ its previous state, in a React-
6
- * like fashion, so that you can compare current state with previous state
7
- * after a render (like React's `commponentDidUpdate`). One benefit of doing
8
- * things this way is that you can put all of your reactions to state changes
9
- * in one place, in `renderedCallback`, rather than having them in various
10
- * places throughout the component.
11
- *
12
- * The API consists in `this.prevState`, `this.state`, and `this.setState`.
13
- *
14
- * Usage:
15
- *
16
- * ```
17
- * type MyState = {
18
- * isFetchingContent: boolean;
19
- * };
20
- *
21
- * class MyFetchingComponent extends LightningElementWithState<MyState> {
22
- * constructor() {
23
- * // `this.state` can only be initialized once
24
- * this.state = {
25
- * isFetchingContent: false
26
- * };
27
- * }
28
- *
29
- * // Queued for execution whenever a `setState` call completes
30
- * renderedCallback() {
31
- * if (this.prevState.isFetchingContent && !this.state.isFetchingContent) {
32
- * // Do something knowing that we just finished fetching.
33
- * notifyFetchSuccessful();
34
- * }
35
- * }
36
- *
37
- * fetchSomething() {
38
- * this.setState({
39
- * isFetchingContent: true
40
- * });
41
- *
42
- * fetch(whatever).then(() => {
43
- * this.setState({
44
- * isFetching: false
45
- * }
46
- * });
47
- * }
48
- * }
49
- * ```
50
- */
51
- export abstract class LightningElementWithState<
52
- T extends { [key: string]: unknown }
53
- > extends LightningElement {
54
- private _prevState = {} as T;
55
- @track private _state = {} as T;
56
-
57
- private _didInitializeState = false;
58
-
59
- protected get prevState(): T {
60
- return Object.freeze({
61
- ...this._prevState
62
- });
63
- }
64
-
65
- protected get state(): T {
66
- return Object.freeze({
67
- ...this._state
68
- });
69
- }
70
-
71
- protected set state(initialState: T) {
72
- if (!this._didInitializeState) {
73
- this._state = {
74
- ...initialState
75
- };
76
- this._didInitializeState = true;
77
- } else {
78
- throw new Error(
79
- "To mutate state after initialization, use `this.setState`."
80
- );
81
- }
82
- }
83
-
84
- protected setState = (state: Partial<T>): void => {
85
- this._prevState = {
86
- ...this._state
87
- };
88
- this._state = {
89
- ...this._state,
90
- ...state
91
- };
92
- };
93
- }