Skip to content

Scrollspy keyboard access in docs#31578

Merged
XhmikosR merged 1 commit into
mainfrom
main-fod-docs-scrollspy
Sep 15, 2020
Merged

Scrollspy keyboard access in docs#31578
XhmikosR merged 1 commit into
mainfrom
main-fod-docs-scrollspy

Conversation

@ffoodd

@ffoodd ffoodd commented Sep 2, 2020

Copy link
Copy Markdown
Contributor

Mention using tabindex="0" on scrollable areas and apply it in our examples, to ensure keyboard access as stated in axe-core and explained by Heydon Pickering in its inclusive components (eg. "Content Slider").

Comment thread site/content/docs/5.0/components/scrollspy.md Outdated
@ffoodd ffoodd force-pushed the main-fod-docs-scrollspy branch from 5710803 to 3bda47e Compare September 3, 2020 08:34
@ffoodd ffoodd requested a review from patrickhlauke September 7, 2020 09:02
@XhmikosR

Copy link
Copy Markdown
Member

@patrickhlauke LGTY?

When successfully implemented, your nav or list group will update accordingly, moving the `.active` class from one item to the next based on their associated targets.

{{< callout >}}
### Spying on elements other than the `<body>`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say this is more a quick tip on "Scrollable containers" - not specific to spying

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is:

  1. if you're not spying body, you'll have a scrollable container,
  2. if we mention "scrollable containers", body is concerned.

I'm not sure how I should reword this, I may be misunderstanding both words and concepts here.

@patrickhlauke patrickhlauke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the tiny change in heading, it looks good

@patrickhlauke

patrickhlauke commented Sep 15, 2020

Copy link
Copy Markdown
Member

my point is: this isn't about spying per se. the tip is in general about how to make a proper div or whatever that works as a scrollable container and is keyboard accessible. the "spying" bit is incidental. (and i don't think that this would confuse folks with <body>...but if you think it would, disambiguate in the first sentence "If you're using a <div> or similar element as a scrollable container")

@ffoodd ffoodd force-pushed the main-fod-docs-scrollspy branch from 0c45500 to ac5bb49 Compare September 15, 2020 15:25
@ffoodd

ffoodd commented Sep 15, 2020

Copy link
Copy Markdown
Contributor Author

@patrickhlauke I reworded things a bit. Is that better?

@patrickhlauke

Copy link
Copy Markdown
Member

:shipit:

@XhmikosR XhmikosR merged commit 390ce24 into main Sep 15, 2020
@XhmikosR XhmikosR deleted the main-fod-docs-scrollspy branch September 15, 2020 15:29
olsza pushed a commit to olsza/bootstrap that referenced this pull request Oct 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants