[Feat] Add custom overlays example to website examples
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.5k
- Forks
- 1.4k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 3
Description
Target Use Case
The update guide https://visgl.github.io/react-map-gl/docs/upgrade-guide#module-exports references the custom overlays https://github.com/visgl/react-map-gl/tree/7.0-release/examples/custom-overlay.
However, those are not part of the website examples https://visgl.github.io/react-map-gl/examples/; https://visgl.github.io/react-map-gl/examples/custom-overlay returns a 404.
Proposal
Add the custom overlay example to the website.
It looks like the code for that is https://github.com/visgl/react-map-gl/blob/master/website/src/examples-sidebar.js#L24. And it looks like and MDX file like https://github.com/visgl/react-map-gl/blob/master/website/src/examples/custom-cursor.mdx is needed as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with website/src/examples-sidebar.js and compare website/src/examples/custom-cursor.mdx, then review the existing examples/custom-overlay code from the 7.0-release branch. Add the custom overlay example to the website examples navigation and page structure; done means the example appears in the examples list and its URL no longer returns 404.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100