formik
formik copied to clipboard
jaredpalmer
Docs layout is a bit broken
Bug report
Current Behavior
The docs' layout is a bit broken, here is a screenshot:
As you can see, there are a couple of issues, namely there is no padding around the edges of the page, there is horizontal scrollbar, and most importantly, when I scroll the page, the ON THIS PAGE part doesn't scroll with it, so I can't access the links after the onReset link
Expected behavior
I'd expect there to be some padding/margin around the Formik logo and the left sidenav, I'd expect there to not be any horizontal scrollbar and most importantly I'd expect to be able to scroll the ON THIS PAGE section to access all the links.
Reproducible example
https://formik.org/docs/api/formik#onreset-values-values-formikbag-formikbag--void
Your environment
I also found this and it can be fixed by 2 methods:
-
By adjusting padding and the middle container's width. However, if the right-side container contains the links like component?: React.ComponentType<FormikProps<Values>> or anything longer, then it creates the same issue again.
-
Using overflow-x: auto for right-side container can fix the issue for overflowing the whole page. However, to view the last link of the right container, we have to scroll all the way to the bottom. To address this, we can apply height:100vh and overflox-y: auto to same right container.
However, I saw someone's comment, and according to him, this kind of issue doesn't count as a bug. Can you help me figure this out? I'm new to open source and would like to contribute."
@CelestialAlchemist Welcome to the open source community! You're right that this wasn't the appropriate place to submit the issue, it turns out that there is a separate repo for the Formik docs. But last commit there was from 7 years ago, and I'm not even sure if that's the repo that is used for the actual Formik docs. But a word of advice - before writing any code (suggestions like you did are fine though) and making a PR, make sure to coordinate it with the maintainers of the repo, because it can turn out that it won't be something that the maintainers want to add, and it may also turn out that the repo isn't even being actively maintained. So always make sure to have the maintainer's approval before writing any code and making a PR. I hope this helps on your open source journey and good luck!
P.S If you want you can create an issue on the Formik docs repo
First of all, sorry for the late reply, and thank you so much, @JorensM, for your advice. I'll keep this in mind.