From 04c3555babd5c65a15cafafadf6ce41cf1bb6920 Mon Sep 17 00:00:00 2001 From: NathanAP Date: Thu, 17 Nov 2022 19:12:31 -0300 Subject: [PATCH] Updated version and docs to prepare for 0.1.5. Also fixed the README and the issue template to be more organic. --- .github/ISSUE_TEMPLATE/bug_report.md | 20 ++++-- README.md | 22 ++++-- docs/package-lock.json | 20 +++--- docs/package.json | 4 +- docs/src/.vuepress/config.js | 1 + docs/src/components/cluster.md | 8 ++- docs/src/examples/README.md | 2 + ...derer-function-and-clustering-algorithm.md | 71 +++++++++++++++++++ docs/src/index.md | 2 +- package-lock.json | 28 ++++---- package.json | 2 +- 11 files changed, 139 insertions(+), 41 deletions(-) create mode 100644 docs/src/examples/using-custom-renderer-function-and-clustering-algorithm.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 791a71c..f1b3a1d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ labels: '' assignees: '' --- -**Read before opening a new issue** +**Read before opening a new issue (I suggest you read in preview mode)** **Are you asking a question or need help?** Please use Github discussion, you will find better help there. Notice that if you create a question issue, we will close it and create a new discussion for you. @@ -15,12 +15,20 @@ Notice that if you create a question issue, we will close it and create a new di You should trying enabling events before using them. More details here: https://vue-map.netlify.app/docs/#register-google-maps-events. -**Codepen support** -You can use Codepen to report your bug! -In your Codepen, go to Settings, then select JS. In Add Packages section, search for vue-google-maps-community-fork +**Playcode support** +We strongly recommend you to use Playcode to reproduce your code! +You can find a small template [here](https://playcode.io/1012771). +Following the steps on the template will make things really, really easier! -**You can delete whatever part you want in this issue, but please be clear and remember to use the Preview option** -**Also, remember to look if this issue isn't already created** +**Codepen support** +You can use Codepen to report your bug as well! +In your Codepen, go to Settings, then select JS. In Add Packages section, search for vue-google-maps-community-fork. +TBH Codepen isn't a really good option because of the file structure, but feel free to use if you prefer it! + +**Lastly, remember to look if this issue isn't already created** + +**OK! You can delete everything until here!** +**You can also delete whatever part you want in this issue, but please make it clear** **Describe what you're reporting** Don't be ashamed to show what you're doing. Give us a clear and concise description of what the bug is. diff --git a/README.md b/README.md index adcee18..7c2e66f 100644 --- a/README.md +++ b/README.md @@ -54,11 +54,16 @@ app .mount('#app') ``` -### IMPORTANT ABOUT CONFIGURATION +### AN IMPORTANT POINT ABOUT YOUR CONFIGURATION -If you are getting a "Requested module 'fast-deep-equal' does not provide an export named 'default'" error, please notice: +You might be getting the following error: -- We are are aware of [this error](https://github.com/NathanAP/vue-google-maps-community-fork/issues/4) and we hope that it will be fixed soon. +`Requested module 'fast-deep-equal' does not provide an export named 'default'` + +Please notice: + +- [We are aware](https://github.com/NathanAP/vue-google-maps-community-fork/issues/4) of this problem. +- We hope that it will be fixed soon enough. - To avoid it right now, you need to do this configuration in your `vite.config.js`: ```js @@ -70,7 +75,8 @@ If you are getting a "Requested module 'fast-deep-equal' does not provide an exp }, ``` -- This **WILL NOT** fix it. This is a hack, please follow the issue to keep track of the situation. +- This **IS NOT** a fix. This is just a hack we are using to avoid the problem. +- Please subscribe to the issue to stay in touch with this problem ### Use it anywhere in your components @@ -129,6 +135,8 @@ export default { If you have too many markers, it is helpful to cluster markers. You can easily cluster markers by wrapping your markers with `GMapCluster` component. +Note: clusters were not working in the original version of this package. All of the clusters are here because of the community fixes. If you're having trouble with it please [try using the docs](https://vue-google-maps-community-fork.netlify.app/components/cluster.html). Also, feel free to open discussions or issues to get help. + ```vue