[v3.0.0] Documentation: GeoObjects, Controls

[gribnoysup]

v3.0.0 in the next branch is getting close to release. One of the finishing steps is:

• Add separate documentation pages for all GeoObjects and Controls following the same structure that is used for already existing ones

• [x] Map

GeoObjects (taken by @mmarkelov) (done! 🎉)

• [x] GeoObject
• [x] Placemark
• [x] Polyline
• [x] Rectangle
• [x] Polygon
• [x] Circle
• [x] Clusterer
• [x] ObjectManager

Controls

• [x] Button
• [x] FullscreenControl (taken by @mmarkelov)
• [x] GeolocationControl (taken by @mmarkelov)
• [x] ListBox (taken by @mmarkelov)
• [x] ListBoxItem (taken by @mmarkelov)
• [x] RouteButton (taken by @mmarkelov)
• [x] RouteEditor
• [x] RoutePanel
• [x] RulerControl
• [x] SearchControl
• [x] TrafficControl
• [x] TypeSelector
• [x] ZoomControl

If you want to help with documenting them, please mention which one you want to take 🙏

[mmarkelov]

@gribnoysup I'll take Placemark to start

[gribnoysup]

@mmarkelov if you have any issues or questions about how to approach this, don't hesitate to open a [WIP] PR and we can discuss, or just ask here 👍

[mmarkelov]

I will also take Polyline

[mmarkelov]

I'll take all GeoObjects

[gribnoysup]

@mmarkelov If you want to, I can give you collaborator access to the repo, so you don't need to maintain your fork and merge it with upstream all the time. Again, if you want to, for which account you would prefer to get this?

[mmarkelov]

@gribnoysup It will be great! You can give it to mmarkelov account! Thanks!

[mmarkelov]

I'll also take first 5 of Controls

[gribnoysup]

Taking the rest of Controls 👌

[mmarkelov]

@gribnoysup I got lots of errors with current next brunch. I suppose something wrong with react-live. Here is log

[gribnoysup]

@mmarkelov it seems that those are mostly warnings, and some of them are expected, for example, isOpen on DOM element and lineHeight on DOM element. This is caused by rebass passing some style-specific component props directly to the DOM nodes. But there is quite a lot of errors that I don't see locally or on the deployed build (as they are just warnings, deployed version doesn't show warnings in production mode). Can you push your changes in a separate branch so I can check what could be wrong there?

[mmarkelov]

@gribnoysup I just pull current next branch and launch yarn run dev. Now I think that something maybe wrong with styles - cause I just haven't got map here

[mmarkelov]

@gribnoysup I think something is wrong https://github.com/gribnoysup/react-yandex-maps/blob/1eb1c8ccc55ddbeb2fb76627305ebf26a3a6ef77/docs/components/LiveEditor.js#L26 here

[gribnoysup]

@mmarkelov I think the issue is somewhere in the dependencies of the docs. I couldn't reproduce the issue before as I don't use yarn and package-lock handles locking of the dependencies in this project when npm is used. Yarn ignores package-lock file and some minor changes in dependencies are breaking the build, unfortunately. I installed yarn and reinstalled project dependencies with yarn and got exactly the same errors that you are getting. I reinstalled everything with npm again and all the issues disappeared. I'll try to figure out what dependency is causing the issue. In the meantime, it should be working for you, if you reinstall docs dependencies with npm 5+

[mmarkelov]

@gribnoysup thank you! I should do it myself. It was fine just a few commits ago. I hope it help, I’ll also try to find it myself. Thanks as always!

[mmarkelov]

@gribnoysup that is all fine with npm. Thanks!

[gribnoysup]

Yay, done and in the next branch #82 🎉