@opengeoweb/core 1.3.0 → 2.1.0

package/README.md

@@ -14,9 +14,9 @@ npm install @opengeoweb/core
 
 ## Use
 
-You can use any component exported from core by importing them. Below you can find a simplified example on how the MapViewConnect component and several mapActions could be used:
+You can use any component exported from core by importing them. Some components need to be wrapped in the CoreThemeProvider, or CoreThemeStoreProvider for a connected component. You can also pass in your own theme if needed. Below you can find a simplified example on how the MapViewConnect component and several mapActions could be used:
 
-```
+```javascript
 import { useDispatch } from 'react-redux';
 import {
   mapActions,
@@ -24,12 +24,11 @@ import {
   LegendConnect,
   LegendMapButtonConnect,
   TimeSliderConnect,
+  CoreThemeStoreProvider,
+  store,
 } from '@opengeoweb/core';
 
-
-const ConnectedMapWithTimeSlider = ({
-  mapId,
-}) => {
+const ConnectedMapWithTimeSlider = ({ mapId }) => {
   const dispatch = useDispatch();
 
   React.useEffect(() => {
@@ -45,16 +44,16 @@ const ConnectedMapWithTimeSlider = ({
   }, []);
 
   return (
-        <LegendConnect initialActiveMapId={mapId}/>
-        <LegendMapButtonConnect mapId={mapId} />
-        <MapViewConnect mapId={mapId} displayTimeInMap />
-        <TimeSliderConnect sourceId="timeslider-1" mapId={mapId} />
+    <CoreThemeStoreProvider store={store}>
+      <LegendConnect initialActiveMapId={mapId} />
+      <LegendMapButtonConnect mapId={mapId} />
+      <MapViewConnect mapId={mapId} displayTimeInMap />
+      <TimeSliderConnect sourceId="timeslider-1" mapId={mapId} />
+    </CoreThemeStoreProvider>
   );
 };
 
 export default ConnectedMapWithTimeSlider;
-
-
 ```
 
 ## Documentation