You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,6 @@
16
16
17
17
Use our Codesandbox template to quickly try out this library without any setup required. https://codesandbox.io/s/base-template-n0vp9
18
18
19
-
## **Add any of our packages to your project**
20
-
21
-
In this case, navigate to your project folder in a terminal and execute the following steps:
22
-
23
-
1. Add @mapcomponents/{package} as a dependency to your project using `npm i @mapcomponents/{package}`.
24
-
2. Add the MapComponentsProvider (named export of this module) to your applications react-DOM where it makes sense. Only children of this component will be able to render a map canvas or interact with a maplibre-gl instance. Place it in the index.js entrypoint if your application is a dedicated map app and all components have a high probability to interact with the maplibre-gl instance. Place it somewhere higher in the JSX tree if the map constitutes only a small portion of your app and components outside of the MapComponentsProvider have no need to interact with the map instance.
25
-
3. Add a MapLibreMap component to the react-DOM wherever the map canvas is supposed to be placed.
26
19
27
20
## **How to use @mapcomponents/react-maplibre in a new project**
This will start a development server that serves the mapcomponents app on port 5174 of your local machine as well as a browser tab with live reload enabled. This reloads the affected parts of the application if changes are detected to the corresponding files in the filesystem. Open the project folder in the IDE of your choice and start building your map client.
In this case, navigate to your project folder in a terminal and execute the following steps:
81
+
82
+
1. Add @mapcomponents/{package} as a dependency to your project using `npm i @mapcomponents/{package}`.
83
+
2. Add the MapComponentsProvider (named export of this module) to your applications react-DOM where it makes sense. Only children of this component will be able to render a map canvas or interact with a maplibre-gl instance. Place it in the index.js entrypoint if your application is a dedicated map app and all components have a high probability to interact with the maplibre-gl instance. Place it somewhere higher in the JSX tree if the map constitutes only a small portion of your app and components outside of the MapComponentsProvider have no need to interact with the map instance.
84
+
3. Add a MapLibreMap component to the react-DOM wherever the map canvas is supposed to be placed.
84
85
85
86
Please take a look at our storybooks and the code examples provided in the {ComponentName}.stories.tsx files next to the Components in the `./src/components/` folder.
0 commit comments