-
Notifications
You must be signed in to change notification settings - Fork 841
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
[Docs] Fixing up some more pages under Navigation #5053
Conversation
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
1 similar comment
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
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.
Didn't know if you were ready for review, but I had some time. Ran through this in code / docs. Looks pretty good. Think the treeview playground is the only place I noticed any issues.
Looks like you also made a bunch of changes to the accessibility of the docs (mostly around some of our utility pages). Might want to comment that up in your PR description.
Really nice work.
@@ -1,4 +1,4 @@ | |||
import { EuiPagination, EuiText } from '../../../../src/components/'; |
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.
/** | ||
* Never accepts children directly, only through the `items` prop | ||
*/ | ||
children?: never; |
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.
TIL
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.
Tried out some Omit
options, but this appears to be the best way to remove support.
I'm starting to think we might need an actual |
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
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.
LGTM
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
/** | ||
* Never accepts children directly, only through the `items` prop | ||
*/ | ||
children?: never; |
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.
Tried out some Omit
options, but this appears to be the best way to remove support.
Preview documentation changes for this PR: https://eui.elastic.co/pr_5053/ |
A. The main docs pages that were touched were:
a. I also removed all the
aria-label
s from the snippets because EuiBreadcrumbs has a default value so it's not absolutely necessary to provide a custom one. I confirmed with @myasonik (😭) that we only add custom ones in our examples because you can't have multiple on the same page with the same label. But I did add a callout about it.B. Other related changes
1. EuiNotificationBadge
Closes #4992 by reducing the border-radius in Amsterdam theme
2. EuiPagination
Fixed the default active page to the actual first page. The
activePage
is actually0
based index, but the default was set to1
making it default to selecting page 2. 🤣3. EuiTreeView
This is a component that controls the render of it's items through an object passed as a prop. While
children
was actually allowed via TS, it would error if you tried to pass any. So I set it to never allow children withchildren?: never;
4. EuiFacet
Updated the focus states in Amsterdam to match our established patter.
5. Changed doc's snippet code language from
html
tojsx
Mainly because nested objects made it very confused.
6. Reduced Playground code from 4 space indents to 2 spaces
Checklist