@mapcomponents/react-maplibre 0.1.10 → 0.1.14

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,10 +9,10 @@ labels: 'Status: Unconfirmed'
 <!--
   Please provide a clear and concise description of what the bug is. Include
   screenshots if needed. Please test using the latest version of the relevant
-  react-map-components-maplibre package to make sure your issue has not already been fixed.
+  @mapcomponents/react-maplibre package to make sure your issue has not already been fixed.
 -->
 
-react-map-components-maplibre version:
+@mapcomponents/react-maplibre version:
 
 ## Steps To Reproduce
 

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
-name: "🫀 Feature request"
-about: Suggest a new idea for react-map-components-maplibre.
+name: "💕 Feature request"
+about: Suggest a new idea for @mapcomponents/react-maplibre.
 title: 'Feature: '
 labels: 'Status: needs print'
 Assignees: ''
@@ -11,7 +11,7 @@ Assignees: ''
 -->
 
 
-react-map-components-maplibre version:
+@mapcomponents/react-maplibre version:
 
 ## Feature description
 

package/.github/workflows/node_version_test.yml

@@ -0,0 +1,25 @@
+name: tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-versions: [10.x, 12.x, 14.x, 15.x, 16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+      # Setup .npmrc file to publish to npm
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn
+      - run: yarn test:noninteractive

package/.github/workflows/storybook.yml

@@ -1,4 +1,4 @@
-name: Build and Deploy Storybook
+name: Build and deploy storybook
 on: 
   [push]
 jobs:
@@ -9,10 +9,13 @@ jobs:
         uses: actions/checkout@v2.3.1
         with:
           persist-credentials: false
-      - name: Install and Build 🔧
+      - name: Install and build 🔧
         run: | # Install packages and build the Storybook files
-          yarn install
+          yarn
+          yarn build-catalogue-meta
+          yarn build-catalogue-markdown-docs
           yarn build-storybook
+          npx sb extract ./docs-build ./docs-build/stories.json
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@3.6.2
         with:

package/CONTRIBUTING.md

@@ -71,7 +71,7 @@ Depending on how large the project is, you may want to outsource the questioning
 A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
 - Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://mapcomponents.github.io/react-map-components-maplibre/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
 - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/mapcomponents/react-map-components-maplibre/issues?q=label%3Abug).
 - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
 - Collect information about the bug:
@@ -111,7 +111,7 @@ This section guides you through submitting an enhancement suggestion for react-m
 #### Before Submitting an Enhancement
 
 - Make sure that you are using the latest version.
-- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Read the [documentation](https://mapcomponents.github.io/react-map-components-maplibre) carefully and find out if the functionality is already covered, maybe by an individual configuration.
 - Perform a [search](https://github.com/mapcomponents/react-map-components-maplibre/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 

package/README.md

@@ -4,6 +4,9 @@
 
 [![npm version](https://badge.fury.io/js/@mapcomponents%2Freact-maplibre.svg)](https://badge.fury.io/js/@mapcomponents%2Freact-maplibre) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) ![downloads](https://img.shields.io/npm/dt/@mapcomponents%2Freact-maplibre.svg) ![downloads](https://img.shields.io/npm/dm/@mapcomponents%2Freact-maplibre.svg)
 
+![Tests](https://github.com/mapcomponents/react-map-components-maplibre/actions/workflows/node_version_test.yml/badge.svg)
+
+
 ## Getting started (Using the storybook dev server)
 
 1. Clone the repository and ```cd``` into the folder 
@@ -146,13 +149,6 @@ Example implementation of a component in context with all required dependent com
 
 More information on writing storybook stories for react components: https://storybook.js.org/docs/react/get-started/browse-stories
 
-## LoadingOverlay and LoadingOverlayProvider (currently located in ./ui_components/)
-
-The loading overlay component is added in the storybook decorator.
-Without any further configuration it will listen for new MapLibre instances registered in MapContext and fade out once all of them have fired an "idle" event. For more precise control the LoadingOverlayContext provides a ```loadingOverlayContext.setControlled(true)``` function that will, if called with true as first parameter, switch the LoadingOverlay to manual control. Once the application has loaded completely call the ```loadingOverlayContext.setLoadingDone(true)``` function to trigger the LoadingOverlay Component to fade out.
-
-For decorator integration examples check the storybook decorators located in ./decorators/.
-
 # Tests
 
 ```