@elliemae/ds-side-panel 2.0.0-rc.5 → 2.0.0-rc.9
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 +5 -5
- package/types/SidePanel.d.ts +78 -11
- package/types/SidePanelHeader.d.ts +35 -5
- package/types/TemplateBasicPageWithSidePanel.d.ts +71 -10
- package/types/props.d.ts +81 -10
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elliemae/ds-side-panel",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.9",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "ICE MT - Dimsum - Side Panel",
|
|
6
6
|
"module": "./esm/index.js",
|
|
@@ -52,10 +52,10 @@
|
|
|
52
52
|
"build": "node ../../scripts/build/build.js"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"@elliemae/ds-button": "2.0.0-rc.
|
|
56
|
-
"@elliemae/ds-grid": "2.0.0-rc.
|
|
57
|
-
"@elliemae/ds-icons": "2.0.0-rc.
|
|
58
|
-
"@elliemae/ds-system": "2.0.0-rc.
|
|
55
|
+
"@elliemae/ds-button": "2.0.0-rc.9",
|
|
56
|
+
"@elliemae/ds-grid": "2.0.0-rc.9",
|
|
57
|
+
"@elliemae/ds-icons": "2.0.0-rc.9",
|
|
58
|
+
"@elliemae/ds-system": "2.0.0-rc.9",
|
|
59
59
|
"react-desc": "~4.1.3"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
package/types/SidePanel.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
import React from 'react';
|
|
2
3
|
declare const SidePanel: {
|
|
3
4
|
({ children, isOpen, footer, header, panelContent, panelWidth, panelContentOverflow, widthWhenIsClosed, noGridInfluencer, withBorder, withBoxShadow, }: {
|
|
@@ -15,16 +16,66 @@ declare const SidePanel: {
|
|
|
15
16
|
}): React.ReactElement;
|
|
16
17
|
propTypes: {
|
|
17
18
|
children: any;
|
|
18
|
-
isOpen:
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
19
|
+
isOpen: {
|
|
20
|
+
defaultValue<T = unknown>(arg: T): {
|
|
21
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
22
|
+
};
|
|
23
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
24
|
+
};
|
|
25
|
+
footer: {
|
|
26
|
+
defaultValue<T = unknown>(arg: T): {
|
|
27
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
28
|
+
};
|
|
29
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
30
|
+
};
|
|
31
|
+
header: {
|
|
32
|
+
defaultValue<T = unknown>(arg: T): {
|
|
33
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
34
|
+
};
|
|
35
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
36
|
+
};
|
|
37
|
+
panelContent: {
|
|
38
|
+
defaultValue<T = unknown>(arg: T): {
|
|
39
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
40
|
+
};
|
|
41
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
42
|
+
};
|
|
43
|
+
panelWidth: {
|
|
44
|
+
defaultValue<T = unknown>(arg: T): {
|
|
45
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
46
|
+
};
|
|
47
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
48
|
+
};
|
|
49
|
+
widthWhenIsClosed: {
|
|
50
|
+
defaultValue<T = unknown>(arg: T): {
|
|
51
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
52
|
+
};
|
|
53
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
54
|
+
};
|
|
55
|
+
panelContentOverflow: {
|
|
56
|
+
defaultValue<T = unknown>(arg: T): {
|
|
57
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
58
|
+
};
|
|
59
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
60
|
+
};
|
|
61
|
+
withBorder: {
|
|
62
|
+
defaultValue<T = unknown>(arg: T): {
|
|
63
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
64
|
+
};
|
|
65
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
66
|
+
};
|
|
67
|
+
withBoxShadow: {
|
|
68
|
+
defaultValue<T = unknown>(arg: T): {
|
|
69
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
70
|
+
};
|
|
71
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
72
|
+
};
|
|
73
|
+
noGridInfluencer: {
|
|
74
|
+
defaultValue<T = unknown>(arg: T): {
|
|
75
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
76
|
+
};
|
|
77
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
78
|
+
};
|
|
28
79
|
};
|
|
29
80
|
defaultProps: {
|
|
30
81
|
isOpen: boolean;
|
|
@@ -35,6 +86,22 @@ declare const SidePanel: {
|
|
|
35
86
|
withBoxShadow: boolean;
|
|
36
87
|
};
|
|
37
88
|
};
|
|
38
|
-
declare const DSSidePanelWithSchema:
|
|
89
|
+
declare const DSSidePanelWithSchema: {
|
|
90
|
+
(props?: {
|
|
91
|
+
children: any;
|
|
92
|
+
isOpen: any;
|
|
93
|
+
footer: any;
|
|
94
|
+
header: any;
|
|
95
|
+
panelContent: any;
|
|
96
|
+
panelWidth: any;
|
|
97
|
+
panelContentOverflow: any;
|
|
98
|
+
widthWhenIsClosed: any;
|
|
99
|
+
noGridInfluencer: any;
|
|
100
|
+
withBorder?: boolean | undefined;
|
|
101
|
+
withBoxShadow?: boolean | undefined;
|
|
102
|
+
} | undefined): JSX.Element;
|
|
103
|
+
propTypes: unknown;
|
|
104
|
+
toTypescript: () => import("react-desc").TypescriptSchema;
|
|
105
|
+
};
|
|
39
106
|
export { SidePanel, DSSidePanelWithSchema };
|
|
40
107
|
export default SidePanel;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
/// <reference types="react" />
|
|
2
3
|
declare const SidePanelHeader: {
|
|
3
4
|
({ title, additionalAction, onClose, showClose }: {
|
|
@@ -8,14 +9,43 @@ declare const SidePanelHeader: {
|
|
|
8
9
|
}): JSX.Element;
|
|
9
10
|
propTypes: {
|
|
10
11
|
/** Page title */
|
|
11
|
-
title:
|
|
12
|
+
title: {
|
|
13
|
+
defaultValue<T = unknown>(arg: T): {
|
|
14
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
15
|
+
};
|
|
16
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
17
|
+
};
|
|
12
18
|
/** Action button */
|
|
13
|
-
additionalAction:
|
|
19
|
+
additionalAction: {
|
|
20
|
+
defaultValue<T = unknown>(arg: T): {
|
|
21
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
22
|
+
};
|
|
23
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
24
|
+
};
|
|
14
25
|
/** Called when the slide collapse */
|
|
15
|
-
onClose:
|
|
26
|
+
onClose: {
|
|
27
|
+
defaultValue<T = unknown>(arg: T): {
|
|
28
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
29
|
+
};
|
|
30
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
31
|
+
};
|
|
16
32
|
/** Show/Hide close button */
|
|
17
|
-
showClose:
|
|
33
|
+
showClose: {
|
|
34
|
+
defaultValue<T = unknown>(arg: T): {
|
|
35
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
36
|
+
};
|
|
37
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
38
|
+
};
|
|
18
39
|
};
|
|
19
40
|
};
|
|
20
|
-
declare const DSSidePanelHeaderWithSchema:
|
|
41
|
+
declare const DSSidePanelHeaderWithSchema: {
|
|
42
|
+
(props?: {
|
|
43
|
+
title?: null | undefined;
|
|
44
|
+
additionalAction?: null | undefined;
|
|
45
|
+
onClose?: ((...args: any[]) => void) | undefined;
|
|
46
|
+
showClose?: boolean | undefined;
|
|
47
|
+
} | undefined): JSX.Element;
|
|
48
|
+
propTypes: unknown;
|
|
49
|
+
toTypescript: () => import("react-desc").TypescriptSchema;
|
|
50
|
+
};
|
|
21
51
|
export { SidePanelHeader, DSSidePanelHeaderWithSchema };
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
/// <reference types="react" />
|
|
2
3
|
declare const TemplateBasicPageWithSidePanel: {
|
|
3
4
|
({ globalHeader, mainHeader, mainContent, mainFooter, isOpen, onClose, panelFooter, panelHeader, panelContent, panelWidth, }: {
|
|
@@ -16,11 +17,21 @@ declare const TemplateBasicPageWithSidePanel: {
|
|
|
16
17
|
/**
|
|
17
18
|
* Global Header
|
|
18
19
|
*/
|
|
19
|
-
globalHeader:
|
|
20
|
+
globalHeader: {
|
|
21
|
+
defaultValue<T = unknown>(arg: T): {
|
|
22
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
23
|
+
};
|
|
24
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
25
|
+
};
|
|
20
26
|
/**
|
|
21
27
|
* Main Header
|
|
22
28
|
*/
|
|
23
|
-
mainHeader:
|
|
29
|
+
mainHeader: {
|
|
30
|
+
defaultValue<T = unknown>(arg: T): {
|
|
31
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
32
|
+
};
|
|
33
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
34
|
+
};
|
|
24
35
|
/**
|
|
25
36
|
* Main content
|
|
26
37
|
*/
|
|
@@ -28,32 +39,82 @@ declare const TemplateBasicPageWithSidePanel: {
|
|
|
28
39
|
/**
|
|
29
40
|
* Main Footer
|
|
30
41
|
*/
|
|
31
|
-
mainFooter:
|
|
42
|
+
mainFooter: {
|
|
43
|
+
defaultValue<T = unknown>(arg: T): {
|
|
44
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
45
|
+
};
|
|
46
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
47
|
+
};
|
|
32
48
|
/**
|
|
33
49
|
* Should show the slide panel or not
|
|
34
50
|
*/
|
|
35
|
-
isOpen:
|
|
51
|
+
isOpen: {
|
|
52
|
+
defaultValue<T = unknown>(arg: T): {
|
|
53
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
54
|
+
};
|
|
55
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
56
|
+
};
|
|
36
57
|
/**
|
|
37
58
|
* Footer for Slide Panel
|
|
38
59
|
*/
|
|
39
|
-
panelFooter:
|
|
60
|
+
panelFooter: {
|
|
61
|
+
defaultValue<T = unknown>(arg: T): {
|
|
62
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
63
|
+
};
|
|
64
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
65
|
+
};
|
|
40
66
|
/**
|
|
41
67
|
* Header for Slide Panel instance of SlidePanelHeader
|
|
42
68
|
*/
|
|
43
|
-
panelHeader:
|
|
69
|
+
panelHeader: {
|
|
70
|
+
defaultValue<T = unknown>(arg: T): {
|
|
71
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
72
|
+
};
|
|
73
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
74
|
+
};
|
|
44
75
|
/**
|
|
45
76
|
* Content for Slide Panel
|
|
46
77
|
*/
|
|
47
|
-
panelContent:
|
|
78
|
+
panelContent: {
|
|
79
|
+
defaultValue<T = unknown>(arg: T): {
|
|
80
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
81
|
+
};
|
|
82
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
83
|
+
};
|
|
48
84
|
/**
|
|
49
85
|
* Width of the panel open. eg: 300
|
|
50
86
|
*/
|
|
51
|
-
panelWidth:
|
|
87
|
+
panelWidth: {
|
|
88
|
+
defaultValue<T = unknown>(arg: T): {
|
|
89
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
90
|
+
};
|
|
91
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
92
|
+
};
|
|
52
93
|
/**
|
|
53
94
|
* Callback
|
|
54
95
|
*/
|
|
55
|
-
onClose:
|
|
96
|
+
onClose: {
|
|
97
|
+
defaultValue<T = unknown>(arg: T): {
|
|
98
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
99
|
+
};
|
|
100
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
101
|
+
};
|
|
56
102
|
};
|
|
57
103
|
};
|
|
58
|
-
declare const DSTemplateBasicPageWithSidePanel:
|
|
104
|
+
declare const DSTemplateBasicPageWithSidePanel: {
|
|
105
|
+
(props?: {
|
|
106
|
+
globalHeader?: null | undefined;
|
|
107
|
+
mainHeader?: null | undefined;
|
|
108
|
+
mainContent: any;
|
|
109
|
+
mainFooter: any;
|
|
110
|
+
isOpen?: boolean | undefined;
|
|
111
|
+
onClose: any;
|
|
112
|
+
panelFooter: any;
|
|
113
|
+
panelHeader: any;
|
|
114
|
+
panelContent: any;
|
|
115
|
+
panelWidth: any;
|
|
116
|
+
} | undefined): JSX.Element;
|
|
117
|
+
propTypes: unknown;
|
|
118
|
+
toTypescript: () => import("react-desc").TypescriptSchema;
|
|
119
|
+
};
|
|
59
120
|
export { TemplateBasicPageWithSidePanel, DSTemplateBasicPageWithSidePanel };
|
package/types/props.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
export declare const props: {
|
|
2
3
|
/**
|
|
3
4
|
* Main content
|
|
@@ -6,26 +7,96 @@ export declare const props: {
|
|
|
6
7
|
/**
|
|
7
8
|
* Should show the slide panel or not
|
|
8
9
|
*/
|
|
9
|
-
isOpen:
|
|
10
|
+
isOpen: {
|
|
11
|
+
defaultValue<T = unknown>(arg: T): {
|
|
12
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
13
|
+
}; /**
|
|
14
|
+
* Content for Slide Panel
|
|
15
|
+
*/
|
|
16
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
17
|
+
};
|
|
10
18
|
/**
|
|
11
19
|
* Footer for Slide Panel
|
|
12
20
|
*/
|
|
13
|
-
footer:
|
|
21
|
+
footer: {
|
|
22
|
+
defaultValue<T = unknown>(arg: T): {
|
|
23
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
24
|
+
}; /**
|
|
25
|
+
* Content for Slide Panel
|
|
26
|
+
*/
|
|
27
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
28
|
+
};
|
|
14
29
|
/**
|
|
15
30
|
* Header for Slide Panel instance of SlidePanelHeader
|
|
16
31
|
*/
|
|
17
|
-
header:
|
|
32
|
+
header: {
|
|
33
|
+
defaultValue<T = unknown>(arg: T): {
|
|
34
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
35
|
+
}; /**
|
|
36
|
+
* Content for Slide Panel
|
|
37
|
+
*/
|
|
38
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
39
|
+
};
|
|
18
40
|
/**
|
|
19
41
|
* Content for Slide Panel
|
|
20
42
|
*/
|
|
21
|
-
panelContent:
|
|
43
|
+
panelContent: {
|
|
44
|
+
defaultValue<T = unknown>(arg: T): {
|
|
45
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
46
|
+
}; /**
|
|
47
|
+
* Content for Slide Panel
|
|
48
|
+
*/
|
|
49
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
50
|
+
};
|
|
22
51
|
/**
|
|
23
52
|
* Width of the panel open. eg: 300
|
|
24
53
|
*/
|
|
25
|
-
panelWidth:
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
54
|
+
panelWidth: {
|
|
55
|
+
defaultValue<T = unknown>(arg: T): {
|
|
56
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
57
|
+
}; /**
|
|
58
|
+
* Content for Slide Panel
|
|
59
|
+
*/
|
|
60
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
61
|
+
};
|
|
62
|
+
widthWhenIsClosed: {
|
|
63
|
+
defaultValue<T = unknown>(arg: T): {
|
|
64
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
65
|
+
}; /**
|
|
66
|
+
* Content for Slide Panel
|
|
67
|
+
*/
|
|
68
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
69
|
+
};
|
|
70
|
+
panelContentOverflow: {
|
|
71
|
+
defaultValue<T = unknown>(arg: T): {
|
|
72
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
73
|
+
}; /**
|
|
74
|
+
* Content for Slide Panel
|
|
75
|
+
*/
|
|
76
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
77
|
+
};
|
|
78
|
+
withBorder: {
|
|
79
|
+
defaultValue<T = unknown>(arg: T): {
|
|
80
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
81
|
+
}; /**
|
|
82
|
+
* Content for Slide Panel
|
|
83
|
+
*/
|
|
84
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
85
|
+
};
|
|
86
|
+
withBoxShadow: {
|
|
87
|
+
defaultValue<T = unknown>(arg: T): {
|
|
88
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
89
|
+
}; /**
|
|
90
|
+
* Content for Slide Panel
|
|
91
|
+
*/
|
|
92
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
93
|
+
};
|
|
94
|
+
noGridInfluencer: {
|
|
95
|
+
defaultValue<T = unknown>(arg: T): {
|
|
96
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
97
|
+
}; /**
|
|
98
|
+
* Content for Slide Panel
|
|
99
|
+
*/
|
|
100
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
101
|
+
};
|
|
31
102
|
};
|