-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(NcAppNavigationToggle): add comments #5148
chore(NcAppNavigationToggle): add comments #5148
Conversation
96a1f06
to
94071de
Compare
Update: added some comments as well for the docs 👍 |
94071de
to
753f5c2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not think this belongs here but to the photos app, they mess with the styles so it needs to be fixed there.
There are really not nice hacks for the app navigation and event this "force position" is not fixing all problems in photos.
But the doc changes are nice!
Agreed ! Closed the PR, but decided to reopen it for the docs, but not the most important PR ever so this can always wait! |
cc41a21
to
cb4275d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This component is supposed to be used only in <NcAppNavigation>
and actually is not exported from the library.
So we should remove it from the docs at all instead. (in the styleguidist config)
/** | ||
* The NcAppNavigationToggle component is used typically alongside another header navigation component. | ||
* It emits the status of whether the button has been clicked or not. | ||
* | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is supposed to be used only in <NcAppNavigation>
and is not exported from the library.
We should probably remove it from the docs instead.
But I would keep the doc for internal purpose to understand the component itself. |
Not sure so detailed documentation is needed internally for so small a component and props like |
Signed-off-by: Eduardo Morales <[email protected]>
cb4275d
to
1d3a181
Compare
Removed the comment @ShGKme mentioned, as I agree with him 🙏 Further in the future, if it does get used for more things, it can be added again, so I am indifferent 👍 small PR now 😭 |
☑️ For nextcloud/photos#2278
🖼️ Screenshots
🚧 Tasks
This has the same changes from nextcloud/photos#2285
This allows the button to still be in view, while a little tight, and also still allows it to be found with keyboard navigation 👍
Any styling choices can be commented on !
🏁 Checklist