esrieact 0.1.0 → 0.1.1

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.
@@ -69,21 +69,33 @@ interface MapContextProviderProps {
69
69
  children?: ReactNode | ReactNode[];
70
70
  }
71
71
  /**
72
- * Provider which provides the map context to all descedants
72
+ * Provider which provides the map context to all descedants.
73
+ *
74
+ * @Documentation
75
+ * [MapContextProvider](https://slutske22.github.io/esrieact/map-view#mapcontextprovider)
73
76
  */
74
77
  export declare const MapContextProvider: React.FC<MapContextProviderProps>;
75
78
  interface Props extends HTMLAttributes<HTMLDivElement> {
76
79
  /**
77
80
  * Properties passed to the [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html)
81
+ *
82
+ * @Documentation
83
+ * [MapProperties](https://slutske22.github.io/esrieact/map-view#mapproperties)
78
84
  */
79
85
  MapProperties?: __esri.MapProperties;
80
86
  /**
81
87
  * Properties passed to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
88
+ *
89
+ * @Documentation
90
+ * [ViewProperties](https://slutske22.github.io/esrieact/map-view#viewproperties)
82
91
  */
83
92
  ViewProperties?: __esri.MapViewProperties & {
84
93
  /**
85
94
  * Events that are attached to the MapView. Can be an event handler function map, or a function of the `view`
86
95
  * which return an event handler function map
96
+ *
97
+ * @Documentation
98
+ * [ViewProperties.events](https://slutske22.github.io/esrieact/map-view#viewpropertiesevents)
87
99
  */
88
100
  events?: ViewEventHandlerFnMap | ((view: __esri.MapView) => ViewEventHandlerFnMap);
89
101
  };
@@ -96,7 +108,10 @@ interface Props extends HTMLAttributes<HTMLDivElement> {
96
108
  * MapView Component for 2D map. Accepts properties for both the Map and the MapView. Renders the container
97
109
  * div, and once mounted, renders the map to it.
98
110
  *
99
- * ***Does not provide its own Map Context, and as such, will fail if you do not manuaaly provide one***
111
+ * ***Does not provide its own Map Context, and as such, will fail if you do not manually provide one***
112
+ *
113
+ * @Documentation
114
+ * [MapViewCore](https://slutske22.github.io/esrieact/map-view#mapviewcore)
100
115
  *
101
116
  * @example
102
117
  * // App.tsx
@@ -132,6 +147,9 @@ export declare const MapViewCore: React.ForwardRefExoticComponent<Props & React.
132
147
  * MapView Component for 2D map. Accepts properties for both the Map and the MapView. Renders the container
133
148
  * div, and once mounted, renders the map to it.
134
149
  *
150
+ * @Documentation
151
+ * [MapView](https://slutske22.github.io/esrieact/map-view)
152
+ *
135
153
  * ArcGIS JS API Source Components:
136
154
  * - [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html)
137
155
  * - [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
@@ -9,7 +9,10 @@ import { useEsriPropertyUpdates, useEvents, } from "../utils";
9
9
  */
10
10
  export const MapContext = React.createContext({});
11
11
  /**
12
- * Provider which provides the map context to all descedants
12
+ * Provider which provides the map context to all descedants.
13
+ *
14
+ * @Documentation
15
+ * [MapContextProvider](https://slutske22.github.io/esrieact/map-view#mapcontextprovider)
13
16
  */
14
17
  export const MapContextProvider = ({ children, }) => {
15
18
  const [map, setMap] = useState(undefined);
@@ -25,7 +28,10 @@ export const MapContextProvider = ({ children, }) => {
25
28
  * MapView Component for 2D map. Accepts properties for both the Map and the MapView. Renders the container
26
29
  * div, and once mounted, renders the map to it.
27
30
  *
28
- * ***Does not provide its own Map Context, and as such, will fail if you do not manuaaly provide one***
31
+ * ***Does not provide its own Map Context, and as such, will fail if you do not manually provide one***
32
+ *
33
+ * @Documentation
34
+ * [MapViewCore](https://slutske22.github.io/esrieact/map-view#mapviewcore)
29
35
  *
30
36
  * @example
31
37
  * // App.tsx
@@ -90,6 +96,9 @@ export const MapViewCore = React.forwardRef((props, ref) => {
90
96
  * MapView Component for 2D map. Accepts properties for both the Map and the MapView. Renders the container
91
97
  * div, and once mounted, renders the map to it.
92
98
  *
99
+ * @Documentation
100
+ * [MapView](https://slutske22.github.io/esrieact/map-view)
101
+ *
93
102
  * ArcGIS JS API Source Components:
94
103
  * - [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html)
95
104
  * - [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "esrieact",
3
3
  "private": false,
4
- "version": "0.1.0",
4
+ "version": "0.1.1",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "files": [