@arcgis/charts-components-react 4.29.0-beta.28
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/CHANGELOG.md +190 -0
- package/LICENSE.md +12 -0
- package/README.md +15 -0
- package/package.json +31 -0
- package/src/components.ts +26 -0
- package/src/index.ts +1 -0
- package/src/public-api.ts +7 -0
- package/src/react-component-lib/createComponent.tsx +106 -0
- package/src/react-component-lib/createOverlayComponent.tsx +142 -0
- package/src/react-component-lib/index.ts +2 -0
- package/src/react-component-lib/interfaces.ts +34 -0
- package/src/react-component-lib/utils/attachProps.ts +125 -0
- package/src/react-component-lib/utils/case.ts +7 -0
- package/src/react-component-lib/utils/dev.ts +14 -0
- package/src/react-component-lib/utils/index.tsx +50 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
+
|
|
6
|
+
# 4.29.0-beta.28 (2024-02-15)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# 4.29.0-beta.27 (2024-02-15)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# 4.29.0-beta.26 (2024-02-15)
|
|
23
|
+
|
|
24
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
# [4.29.0-beta.25](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.24...v4.29.0-beta.25) (2024-02-14)
|
|
31
|
+
|
|
32
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
# 4.29.0-beta.24 (2024-02-14)
|
|
39
|
+
|
|
40
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
# 4.29.0-beta.23 (2024-02-14)
|
|
47
|
+
|
|
48
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
# 4.29.0-beta.22 (2024-02-14)
|
|
55
|
+
|
|
56
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
# 4.29.0-beta.21 (2024-02-14)
|
|
63
|
+
|
|
64
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
# 4.29.0-beta.20 (2024-02-14)
|
|
71
|
+
|
|
72
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
# [4.29.0-beta.19](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.18...v4.29.0-beta.19) (2024-02-13)
|
|
79
|
+
|
|
80
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
# [4.29.0-beta.18](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.17...v4.29.0-beta.18) (2024-02-12)
|
|
87
|
+
|
|
88
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# [4.29.0-beta.17](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.16...v4.29.0-beta.17) (2024-02-09)
|
|
95
|
+
|
|
96
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
# [4.29.0-beta.16](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.15...v4.29.0-beta.16) (2024-02-08)
|
|
103
|
+
|
|
104
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
# [4.29.0-beta.15](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.14...v4.29.0-beta.15) (2024-02-07)
|
|
111
|
+
|
|
112
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
# [4.29.0-beta.14](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.13...v4.29.0-beta.14) (2024-02-06)
|
|
119
|
+
|
|
120
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
# [4.29.0-beta.13](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.12...v4.29.0-beta.13) (2024-02-05)
|
|
127
|
+
|
|
128
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
# 4.29.0-beta.12 (2024-02-02)
|
|
135
|
+
|
|
136
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
# [4.29.0-beta.11](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.10...v4.29.0-beta.11) (2024-02-02)
|
|
143
|
+
|
|
144
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
# [4.29.0-beta.10](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.9...v4.29.0-beta.10) (2024-01-31)
|
|
151
|
+
|
|
152
|
+
**Note:** Version bump only for package @arcgis/charts-components-react
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
# [4.29.0-beta.9](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.8...v4.29.0-beta.9) (2024-01-31)
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### Bug Fixes
|
|
162
|
+
|
|
163
|
+
* remove obsolete values in react wrapper package.json ([d752de1](https://devtopia.esri.com/WebGIS/arcgis-charts/commits/d752de160c2ab5bce5ca0f92c052817d7cd9c17f))
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
# [4.29.0-beta.8](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.7...v4.29.0-beta.8) (2024-01-30)
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Bug Fixes
|
|
173
|
+
|
|
174
|
+
* correct publish URLs for wrappers ([3cee052](https://devtopia.esri.com/WebGIS/arcgis-charts/commits/3cee0524c438695a09b06bdccf4966610155d33c))
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
# [4.29.0-beta.7](https://devtopia.esri.com/WebGIS/arcgis-charts/compare/v4.29.0-beta.6...v4.29.0-beta.7) (2024-01-30)
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
### Bug Fixes
|
|
184
|
+
|
|
185
|
+
* updated the auto generated files ([9c43cae](https://devtopia.esri.com/WebGIS/arcgis-charts/commits/9c43cae1f9849c37b4b142934f4ef3acdb898f3c))
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### Features
|
|
189
|
+
|
|
190
|
+
* add wrappers as workspaces to include them in release ([ea1fcd3](https://devtopia.esri.com/WebGIS/arcgis-charts/commits/ea1fcd39c47130192f9a35c6582611eee42a5467))
|
package/LICENSE.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Licensing
|
|
2
|
+
COPYRIGHT © 2023 Esri
|
|
3
|
+
|
|
4
|
+
All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
|
|
5
|
+
|
|
6
|
+
This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
|
|
7
|
+
|
|
8
|
+
See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
|
|
9
|
+
|
|
10
|
+
For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
|
|
11
|
+
|
|
12
|
+
email: contracts@esri.com
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# React wrapper for @arcgis/charts-components (beta)
|
|
2
|
+
This Web Component package is part of the ArcGIS Maps SDK for JavaScript and is under active development. At this time, customer support is not provided. More news to come.
|
|
3
|
+
|
|
4
|
+
## License
|
|
5
|
+
COPYRIGHT © 2023 Esri
|
|
6
|
+
|
|
7
|
+
All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
|
|
8
|
+
|
|
9
|
+
This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
|
|
10
|
+
|
|
11
|
+
See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
|
|
12
|
+
|
|
13
|
+
For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
|
|
14
|
+
|
|
15
|
+
email: contracts@esri.com
|
package/package.json
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@arcgis/charts-components-react",
|
|
3
|
+
"description": "A set of React components that wrap ArcGIS charts components",
|
|
4
|
+
"homepage": "https://developers.arcgis.com/javascript/latest/",
|
|
5
|
+
"version": "4.29.0-beta.28",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"license": "SEE LICENSE.md",
|
|
8
|
+
"publishConfig": {
|
|
9
|
+
"registry": "https://registry.npmjs.org/",
|
|
10
|
+
"access": "public"
|
|
11
|
+
},
|
|
12
|
+
"scripts": {
|
|
13
|
+
"clean": "rimraf dist node_modules .turbo",
|
|
14
|
+
"compile": "yarn tsc",
|
|
15
|
+
"pre": "rimraf dist",
|
|
16
|
+
"tsc": "tsc"
|
|
17
|
+
},
|
|
18
|
+
"dependencies": {
|
|
19
|
+
"@arcgis/charts-components": "^4.29.0-beta.28",
|
|
20
|
+
"react": ">=18.0.0 <19.0.0",
|
|
21
|
+
"react-dom": ">=18.0.0 <19.0.0"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"@arcgis/components-plugins": "^4.29.0-beta.1",
|
|
25
|
+
"@arcgis/core": ">=4.29.0-next <4.30",
|
|
26
|
+
"@types/node": "^20.2.5",
|
|
27
|
+
"@types/react-dom": "^18.2.0",
|
|
28
|
+
"rimraf": "^5.0.0",
|
|
29
|
+
"typescript": "~5.3.0"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* auto-generated react proxies */
|
|
4
|
+
import { createReactComponent } from './react-component-lib';
|
|
5
|
+
|
|
6
|
+
import type { JSX } from '@arcgis/charts-components/dist/components';
|
|
7
|
+
|
|
8
|
+
import { defineCustomElement as defineArcgisChartsActionBar } from '@arcgis/charts-components/dist/components/arcgis-charts-action-bar.js';
|
|
9
|
+
import { defineCustomElement as defineArcgisChartsBarChart } from '@arcgis/charts-components/dist/components/arcgis-charts-bar-chart.js';
|
|
10
|
+
import { defineCustomElement as defineArcgisChartsBarLineChart } from '@arcgis/charts-components/dist/components/arcgis-charts-bar-line-chart.js';
|
|
11
|
+
import { defineCustomElement as defineArcgisChartsBoxPlot } from '@arcgis/charts-components/dist/components/arcgis-charts-box-plot.js';
|
|
12
|
+
import { defineCustomElement as defineArcgisChartsGauge } from '@arcgis/charts-components/dist/components/arcgis-charts-gauge.js';
|
|
13
|
+
import { defineCustomElement as defineArcgisChartsHistogram } from '@arcgis/charts-components/dist/components/arcgis-charts-histogram.js';
|
|
14
|
+
import { defineCustomElement as defineArcgisChartsLineChart } from '@arcgis/charts-components/dist/components/arcgis-charts-line-chart.js';
|
|
15
|
+
import { defineCustomElement as defineArcgisChartsPieChart } from '@arcgis/charts-components/dist/components/arcgis-charts-pie-chart.js';
|
|
16
|
+
import { defineCustomElement as defineArcgisChartsScatterPlot } from '@arcgis/charts-components/dist/components/arcgis-charts-scatter-plot.js';
|
|
17
|
+
|
|
18
|
+
export const ArcgisChartsActionBar = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsActionBar, HTMLArcgisChartsActionBarElement>('arcgis-charts-action-bar', undefined, undefined, defineArcgisChartsActionBar);
|
|
19
|
+
export const ArcgisChartsBarChart = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsBarChart, HTMLArcgisChartsBarChartElement>('arcgis-charts-bar-chart', undefined, undefined, defineArcgisChartsBarChart);
|
|
20
|
+
export const ArcgisChartsBarLineChart = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsBarLineChart, HTMLArcgisChartsBarLineChartElement>('arcgis-charts-bar-line-chart', undefined, undefined, defineArcgisChartsBarLineChart);
|
|
21
|
+
export const ArcgisChartsBoxPlot = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsBoxPlot, HTMLArcgisChartsBoxPlotElement>('arcgis-charts-box-plot', undefined, undefined, defineArcgisChartsBoxPlot);
|
|
22
|
+
export const ArcgisChartsGauge = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsGauge, HTMLArcgisChartsGaugeElement>('arcgis-charts-gauge', undefined, undefined, defineArcgisChartsGauge);
|
|
23
|
+
export const ArcgisChartsHistogram = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsHistogram, HTMLArcgisChartsHistogramElement>('arcgis-charts-histogram', undefined, undefined, defineArcgisChartsHistogram);
|
|
24
|
+
export const ArcgisChartsLineChart = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsLineChart, HTMLArcgisChartsLineChartElement>('arcgis-charts-line-chart', undefined, undefined, defineArcgisChartsLineChart);
|
|
25
|
+
export const ArcgisChartsPieChart = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsPieChart, HTMLArcgisChartsPieChartElement>('arcgis-charts-pie-chart', undefined, undefined, defineArcgisChartsPieChart);
|
|
26
|
+
export const ArcgisChartsScatterPlot = /*@__PURE__*/createReactComponent<JSX.ArcgisChartsScatterPlot, HTMLArcgisChartsScatterPlotElement>('arcgis-charts-scatter-plot', undefined, undefined, defineArcgisChartsScatterPlot);
|
package/src/index.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./components";
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import React, { createElement } from 'react';
|
|
2
|
+
|
|
3
|
+
import { attachProps, camelToDashCase, createForwardRef, dashToPascalCase, isCoveredByReact, mergeRefs } from './utils';
|
|
4
|
+
|
|
5
|
+
export interface HTMLStencilElement extends HTMLElement {
|
|
6
|
+
componentOnReady(): Promise<this>;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
interface StencilReactInternalProps<ElementType> extends React.HTMLAttributes<ElementType> {
|
|
10
|
+
forwardedRef: React.RefObject<ElementType>;
|
|
11
|
+
ref?: React.Ref<any>;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export const createReactComponent = <
|
|
15
|
+
PropType,
|
|
16
|
+
ElementType extends HTMLStencilElement,
|
|
17
|
+
ContextStateType = {},
|
|
18
|
+
ExpandedPropsTypes = {}
|
|
19
|
+
>(
|
|
20
|
+
tagName: string,
|
|
21
|
+
ReactComponentContext?: React.Context<ContextStateType>,
|
|
22
|
+
manipulatePropsFunction?: (
|
|
23
|
+
originalProps: StencilReactInternalProps<ElementType>,
|
|
24
|
+
propsToPass: any
|
|
25
|
+
) => ExpandedPropsTypes,
|
|
26
|
+
defineCustomElement?: () => void
|
|
27
|
+
) => {
|
|
28
|
+
if (defineCustomElement !== undefined) {
|
|
29
|
+
defineCustomElement();
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const displayName = dashToPascalCase(tagName);
|
|
33
|
+
const ReactComponent = class extends React.Component<StencilReactInternalProps<ElementType>> {
|
|
34
|
+
componentEl!: ElementType;
|
|
35
|
+
|
|
36
|
+
setComponentElRef = (element: ElementType) => {
|
|
37
|
+
this.componentEl = element;
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
constructor(props: StencilReactInternalProps<ElementType>) {
|
|
41
|
+
super(props);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
componentDidMount() {
|
|
45
|
+
this.componentDidUpdate(this.props);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
componentDidUpdate(prevProps: StencilReactInternalProps<ElementType>) {
|
|
49
|
+
attachProps(this.componentEl, this.props, prevProps);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
render() {
|
|
53
|
+
const { children, forwardedRef, style, className, ref, ...cProps } = this.props;
|
|
54
|
+
|
|
55
|
+
let propsToPass = Object.keys(cProps).reduce((acc: any, name) => {
|
|
56
|
+
const value = (cProps as any)[name];
|
|
57
|
+
|
|
58
|
+
if (name.indexOf('on') === 0 && name[2] === name[2].toUpperCase()) {
|
|
59
|
+
const eventName = name.substring(2).toLowerCase();
|
|
60
|
+
if (typeof document !== 'undefined' && isCoveredByReact(eventName)) {
|
|
61
|
+
acc[name] = value;
|
|
62
|
+
}
|
|
63
|
+
} else {
|
|
64
|
+
// we should only render strings, booleans, and numbers as attrs in html.
|
|
65
|
+
// objects, functions, arrays etc get synced via properties on mount.
|
|
66
|
+
const type = typeof value;
|
|
67
|
+
|
|
68
|
+
if (type === 'string' || type === 'boolean' || type === 'number') {
|
|
69
|
+
acc[camelToDashCase(name)] = value;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return acc;
|
|
73
|
+
}, {} as ExpandedPropsTypes);
|
|
74
|
+
|
|
75
|
+
if (manipulatePropsFunction) {
|
|
76
|
+
propsToPass = manipulatePropsFunction(this.props, propsToPass);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
const newProps: Omit<StencilReactInternalProps<ElementType>, 'forwardedRef'> = {
|
|
80
|
+
...propsToPass,
|
|
81
|
+
ref: mergeRefs(forwardedRef, this.setComponentElRef),
|
|
82
|
+
style,
|
|
83
|
+
};
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* We use createElement here instead of
|
|
87
|
+
* React.createElement to work around a
|
|
88
|
+
* bug in Vite (https://github.com/vitejs/vite/issues/6104).
|
|
89
|
+
* React.createElement causes all elements to be rendered
|
|
90
|
+
* as <tagname> instead of the actual Web Component.
|
|
91
|
+
*/
|
|
92
|
+
return createElement(tagName, newProps, children);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
static get displayName() {
|
|
96
|
+
return displayName;
|
|
97
|
+
}
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
// If context was passed to createReactComponent then conditionally add it to the Component Class
|
|
101
|
+
if (ReactComponentContext) {
|
|
102
|
+
ReactComponent.contextType = ReactComponentContext;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
return createForwardRef<PropType, ElementType>(ReactComponent, displayName);
|
|
106
|
+
};
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import ReactDOM from 'react-dom';
|
|
3
|
+
|
|
4
|
+
import { OverlayEventDetail } from './interfaces';
|
|
5
|
+
import { StencilReactForwardedRef, attachProps, dashToPascalCase, defineCustomElement, setRef } from './utils';
|
|
6
|
+
|
|
7
|
+
interface OverlayElement extends HTMLElement {
|
|
8
|
+
present: () => Promise<void>;
|
|
9
|
+
dismiss: (data?: any, role?: string | undefined) => Promise<boolean>;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface ReactOverlayProps {
|
|
13
|
+
children?: React.ReactNode;
|
|
14
|
+
isOpen: boolean;
|
|
15
|
+
onDidDismiss?: (event: CustomEvent<OverlayEventDetail>) => void;
|
|
16
|
+
onDidPresent?: (event: CustomEvent<OverlayEventDetail>) => void;
|
|
17
|
+
onWillDismiss?: (event: CustomEvent<OverlayEventDetail>) => void;
|
|
18
|
+
onWillPresent?: (event: CustomEvent<OverlayEventDetail>) => void;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export const createOverlayComponent = <OverlayComponent extends object, OverlayType extends OverlayElement>(
|
|
22
|
+
tagName: string,
|
|
23
|
+
controller: { create: (options: any) => Promise<OverlayType> },
|
|
24
|
+
customElement?: any
|
|
25
|
+
) => {
|
|
26
|
+
defineCustomElement(tagName, customElement);
|
|
27
|
+
|
|
28
|
+
const displayName = dashToPascalCase(tagName);
|
|
29
|
+
const didDismissEventName = `on${displayName}DidDismiss`;
|
|
30
|
+
const didPresentEventName = `on${displayName}DidPresent`;
|
|
31
|
+
const willDismissEventName = `on${displayName}WillDismiss`;
|
|
32
|
+
const willPresentEventName = `on${displayName}WillPresent`;
|
|
33
|
+
|
|
34
|
+
type Props = OverlayComponent &
|
|
35
|
+
ReactOverlayProps & {
|
|
36
|
+
forwardedRef?: StencilReactForwardedRef<OverlayType>;
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
let isDismissing = false;
|
|
40
|
+
|
|
41
|
+
class Overlay extends React.Component<Props> {
|
|
42
|
+
overlay?: OverlayType;
|
|
43
|
+
el!: HTMLDivElement;
|
|
44
|
+
|
|
45
|
+
constructor(props: Props) {
|
|
46
|
+
super(props);
|
|
47
|
+
if (typeof document !== 'undefined') {
|
|
48
|
+
this.el = document.createElement('div');
|
|
49
|
+
}
|
|
50
|
+
this.handleDismiss = this.handleDismiss.bind(this);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
static get displayName() {
|
|
54
|
+
return displayName;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
componentDidMount() {
|
|
58
|
+
if (this.props.isOpen) {
|
|
59
|
+
this.present();
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
componentWillUnmount() {
|
|
64
|
+
if (this.overlay) {
|
|
65
|
+
this.overlay.dismiss();
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
handleDismiss(event: CustomEvent<OverlayEventDetail<any>>) {
|
|
70
|
+
if (this.props.onDidDismiss) {
|
|
71
|
+
this.props.onDidDismiss(event);
|
|
72
|
+
}
|
|
73
|
+
setRef(this.props.forwardedRef, null);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
shouldComponentUpdate(nextProps: Props) {
|
|
77
|
+
// Check if the overlay component is about to dismiss
|
|
78
|
+
if (this.overlay && nextProps.isOpen !== this.props.isOpen && nextProps.isOpen === false) {
|
|
79
|
+
isDismissing = true;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return true;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
async componentDidUpdate(prevProps: Props) {
|
|
86
|
+
if (this.overlay) {
|
|
87
|
+
attachProps(this.overlay, this.props, prevProps);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
if (prevProps.isOpen !== this.props.isOpen && this.props.isOpen === true) {
|
|
91
|
+
this.present(prevProps);
|
|
92
|
+
}
|
|
93
|
+
if (this.overlay && prevProps.isOpen !== this.props.isOpen && this.props.isOpen === false) {
|
|
94
|
+
await this.overlay.dismiss();
|
|
95
|
+
isDismissing = false;
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Now that the overlay is dismissed
|
|
99
|
+
* we need to render again so that any
|
|
100
|
+
* inner components will be unmounted
|
|
101
|
+
*/
|
|
102
|
+
this.forceUpdate();
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
async present(prevProps?: Props) {
|
|
107
|
+
const { children, isOpen, onDidDismiss, onDidPresent, onWillDismiss, onWillPresent, ...cProps } = this.props;
|
|
108
|
+
const elementProps = {
|
|
109
|
+
...cProps,
|
|
110
|
+
ref: this.props.forwardedRef,
|
|
111
|
+
[didDismissEventName]: this.handleDismiss,
|
|
112
|
+
[didPresentEventName]: (e: CustomEvent) => this.props.onDidPresent && this.props.onDidPresent(e),
|
|
113
|
+
[willDismissEventName]: (e: CustomEvent) => this.props.onWillDismiss && this.props.onWillDismiss(e),
|
|
114
|
+
[willPresentEventName]: (e: CustomEvent) => this.props.onWillPresent && this.props.onWillPresent(e),
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
this.overlay = await controller.create({
|
|
118
|
+
...elementProps,
|
|
119
|
+
component: this.el,
|
|
120
|
+
componentProps: {},
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
setRef(this.props.forwardedRef, this.overlay);
|
|
124
|
+
attachProps(this.overlay, elementProps, prevProps);
|
|
125
|
+
|
|
126
|
+
await this.overlay.present();
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
render() {
|
|
130
|
+
/**
|
|
131
|
+
* Continue to render the component even when
|
|
132
|
+
* overlay is dismissing otherwise component
|
|
133
|
+
* will be hidden before animation is done.
|
|
134
|
+
*/
|
|
135
|
+
return ReactDOM.createPortal(this.props.isOpen || isDismissing ? this.props.children : null, this.el);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
return React.forwardRef<OverlayType, Props>((props, ref) => {
|
|
140
|
+
return <Overlay {...props} forwardedRef={ref} />;
|
|
141
|
+
});
|
|
142
|
+
};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
// General types important to applications using stencil built components
|
|
2
|
+
export interface EventEmitter<T = any> {
|
|
3
|
+
emit: (data?: T) => CustomEvent<T>;
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
export interface StyleReactProps {
|
|
7
|
+
class?: string;
|
|
8
|
+
className?: string;
|
|
9
|
+
style?: { [key: string]: any };
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface OverlayEventDetail<T = any> {
|
|
13
|
+
data?: T;
|
|
14
|
+
role?: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface OverlayInterface {
|
|
18
|
+
el: HTMLElement;
|
|
19
|
+
animated: boolean;
|
|
20
|
+
keyboardClose: boolean;
|
|
21
|
+
overlayIndex: number;
|
|
22
|
+
presented: boolean;
|
|
23
|
+
|
|
24
|
+
enterAnimation?: any;
|
|
25
|
+
leaveAnimation?: any;
|
|
26
|
+
|
|
27
|
+
didPresent: EventEmitter<void>;
|
|
28
|
+
willPresent: EventEmitter<void>;
|
|
29
|
+
willDismiss: EventEmitter<OverlayEventDetail>;
|
|
30
|
+
didDismiss: EventEmitter<OverlayEventDetail>;
|
|
31
|
+
|
|
32
|
+
present(): Promise<void>;
|
|
33
|
+
dismiss(data?: any, role?: string): Promise<boolean>;
|
|
34
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { camelToDashCase } from './case';
|
|
2
|
+
|
|
3
|
+
export const attachProps = (node: HTMLElement, newProps: any, oldProps: any = {}) => {
|
|
4
|
+
// some test frameworks don't render DOM elements, so we test here to make sure we are dealing with DOM first
|
|
5
|
+
if (node instanceof Element) {
|
|
6
|
+
// add any classes in className to the class list
|
|
7
|
+
const className = getClassName(node.classList, newProps, oldProps);
|
|
8
|
+
if (className !== '') {
|
|
9
|
+
node.className = className;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
Object.keys(newProps).forEach((name) => {
|
|
13
|
+
if (
|
|
14
|
+
name === 'children' ||
|
|
15
|
+
name === 'style' ||
|
|
16
|
+
name === 'ref' ||
|
|
17
|
+
name === 'class' ||
|
|
18
|
+
name === 'className' ||
|
|
19
|
+
name === 'forwardedRef'
|
|
20
|
+
) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
if (name.indexOf('on') === 0 && name[2] === name[2].toUpperCase()) {
|
|
24
|
+
const eventName = name.substring(2);
|
|
25
|
+
const eventNameLc = eventName[0].toLowerCase() + eventName.substring(1);
|
|
26
|
+
|
|
27
|
+
if (!isCoveredByReact(eventNameLc)) {
|
|
28
|
+
syncEvent(node, eventNameLc, newProps[name]);
|
|
29
|
+
}
|
|
30
|
+
} else {
|
|
31
|
+
(node as any)[name] = newProps[name];
|
|
32
|
+
const propType = typeof newProps[name];
|
|
33
|
+
if (propType === 'string') {
|
|
34
|
+
node.setAttribute(camelToDashCase(name), newProps[name]);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
export const getClassName = (classList: DOMTokenList, newProps: any, oldProps: any) => {
|
|
42
|
+
const newClassProp: string = newProps.className || newProps.class;
|
|
43
|
+
const oldClassProp: string = oldProps.className || oldProps.class;
|
|
44
|
+
// map the classes to Maps for performance
|
|
45
|
+
const currentClasses = arrayToMap(classList);
|
|
46
|
+
const incomingPropClasses = arrayToMap(newClassProp ? newClassProp.split(' ') : []);
|
|
47
|
+
const oldPropClasses = arrayToMap(oldClassProp ? oldClassProp.split(' ') : []);
|
|
48
|
+
const finalClassNames: string[] = [];
|
|
49
|
+
// loop through each of the current classes on the component
|
|
50
|
+
// to see if it should be a part of the classNames added
|
|
51
|
+
currentClasses.forEach((currentClass) => {
|
|
52
|
+
if (incomingPropClasses.has(currentClass)) {
|
|
53
|
+
// add it as its already included in classnames coming in from newProps
|
|
54
|
+
finalClassNames.push(currentClass);
|
|
55
|
+
incomingPropClasses.delete(currentClass);
|
|
56
|
+
} else if (!oldPropClasses.has(currentClass)) {
|
|
57
|
+
// add it as it has NOT been removed by user
|
|
58
|
+
finalClassNames.push(currentClass);
|
|
59
|
+
}
|
|
60
|
+
});
|
|
61
|
+
incomingPropClasses.forEach((s) => finalClassNames.push(s));
|
|
62
|
+
return finalClassNames.join(' ');
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Transforms a React event name to a browser event name.
|
|
67
|
+
*/
|
|
68
|
+
export const transformReactEventName = (eventNameSuffix: string) => {
|
|
69
|
+
switch (eventNameSuffix) {
|
|
70
|
+
case 'doubleclick':
|
|
71
|
+
return 'dblclick';
|
|
72
|
+
}
|
|
73
|
+
return eventNameSuffix;
|
|
74
|
+
};
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Checks if an event is supported in the current execution environment.
|
|
78
|
+
* @license Modernizr 3.0.0pre (Custom Build) | MIT
|
|
79
|
+
*/
|
|
80
|
+
export const isCoveredByReact = (eventNameSuffix: string) => {
|
|
81
|
+
if (typeof document === 'undefined') {
|
|
82
|
+
return true;
|
|
83
|
+
} else {
|
|
84
|
+
const eventName = 'on' + transformReactEventName(eventNameSuffix);
|
|
85
|
+
let isSupported = eventName in document;
|
|
86
|
+
|
|
87
|
+
if (!isSupported) {
|
|
88
|
+
const element = document.createElement('div');
|
|
89
|
+
element.setAttribute(eventName, 'return;');
|
|
90
|
+
isSupported = typeof (element as any)[eventName] === 'function';
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
return isSupported;
|
|
94
|
+
}
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
export const syncEvent = (
|
|
98
|
+
node: Element & { __events?: { [key: string]: ((e: Event) => any) | undefined } },
|
|
99
|
+
eventName: string,
|
|
100
|
+
newEventHandler?: (e: Event) => any
|
|
101
|
+
) => {
|
|
102
|
+
const eventStore = node.__events || (node.__events = {});
|
|
103
|
+
const oldEventHandler = eventStore[eventName];
|
|
104
|
+
|
|
105
|
+
// Remove old listener so they don't double up.
|
|
106
|
+
if (oldEventHandler) {
|
|
107
|
+
node.removeEventListener(eventName, oldEventHandler);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// Bind new listener.
|
|
111
|
+
node.addEventListener(
|
|
112
|
+
eventName,
|
|
113
|
+
(eventStore[eventName] = function handler(e: Event) {
|
|
114
|
+
if (newEventHandler) {
|
|
115
|
+
newEventHandler.call(this, e);
|
|
116
|
+
}
|
|
117
|
+
})
|
|
118
|
+
);
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
const arrayToMap = (arr: string[] | DOMTokenList) => {
|
|
122
|
+
const map = new Map<string, string>();
|
|
123
|
+
(arr as string[]).forEach((s: string) => map.set(s, s));
|
|
124
|
+
return map;
|
|
125
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export const dashToPascalCase = (str: string) =>
|
|
2
|
+
str
|
|
3
|
+
.toLowerCase()
|
|
4
|
+
.split('-')
|
|
5
|
+
.map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
|
|
6
|
+
.join('');
|
|
7
|
+
export const camelToDashCase = (str: string) => str.replace(/([A-Z])/g, (m: string) => `-${m[0].toLowerCase()}`);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export const isDevMode = () => {
|
|
2
|
+
return process && process.env && process.env.NODE_ENV === 'development';
|
|
3
|
+
};
|
|
4
|
+
|
|
5
|
+
const warnings: { [key: string]: boolean } = {};
|
|
6
|
+
|
|
7
|
+
export const deprecationWarning = (key: string, message: string) => {
|
|
8
|
+
if (isDevMode()) {
|
|
9
|
+
if (!warnings[key]) {
|
|
10
|
+
console.warn(message);
|
|
11
|
+
warnings[key] = true;
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
};
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
import type { StyleReactProps } from '../interfaces';
|
|
4
|
+
|
|
5
|
+
export type StencilReactExternalProps<PropType, ElementType> = PropType &
|
|
6
|
+
Omit<React.HTMLAttributes<ElementType>, 'style'> &
|
|
7
|
+
StyleReactProps;
|
|
8
|
+
|
|
9
|
+
// This will be replaced with React.ForwardedRef when react-output-target is upgraded to React v17
|
|
10
|
+
export type StencilReactForwardedRef<T> = ((instance: T | null) => void) | React.MutableRefObject<T | null> | null;
|
|
11
|
+
|
|
12
|
+
export const setRef = (ref: StencilReactForwardedRef<any> | React.Ref<any> | undefined, value: any) => {
|
|
13
|
+
if (typeof ref === 'function') {
|
|
14
|
+
ref(value);
|
|
15
|
+
} else if (ref != null) {
|
|
16
|
+
// Cast as a MutableRef so we can assign current
|
|
17
|
+
(ref as React.MutableRefObject<any>).current = value;
|
|
18
|
+
}
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export const mergeRefs = (
|
|
22
|
+
...refs: (StencilReactForwardedRef<any> | React.Ref<any> | undefined)[]
|
|
23
|
+
): React.RefCallback<any> => {
|
|
24
|
+
return (value: any) => {
|
|
25
|
+
refs.forEach((ref) => {
|
|
26
|
+
setRef(ref, value);
|
|
27
|
+
});
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
export const createForwardRef = <PropType, ElementType>(ReactComponent: any, displayName: string) => {
|
|
32
|
+
const forwardRef = (
|
|
33
|
+
props: StencilReactExternalProps<PropType, ElementType>,
|
|
34
|
+
ref: StencilReactForwardedRef<ElementType>
|
|
35
|
+
) => {
|
|
36
|
+
return <ReactComponent {...props} forwardedRef={ref} />;
|
|
37
|
+
};
|
|
38
|
+
forwardRef.displayName = displayName;
|
|
39
|
+
|
|
40
|
+
return React.forwardRef(forwardRef);
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
export const defineCustomElement = (tagName: string, customElement: any) => {
|
|
44
|
+
if (customElement !== undefined && typeof customElements !== 'undefined' && !customElements.get(tagName)) {
|
|
45
|
+
customElements.define(tagName, customElement);
|
|
46
|
+
}
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
export * from './attachProps';
|
|
50
|
+
export * from './case';
|