Skip to content
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

Adding notes about responsive design/smaller screens #721

Open
wants to merge 7 commits into
base: master-2.0
Choose a base branch
from

Conversation

brianelton
Copy link
Collaborator

@brianelton brianelton commented May 9, 2023

Single PR to cover #528, #529, #530, #531

Added notes about responsive design/smaller screen considerations to:

When HTML5 form fields are used, a virtual keyboard appears making it easier to input data.
For example, a `number` field shows a numeric keyboard, a `date` field a native date picker.

While some designs want visual field labels to be dropped, users prefer visible labels as they make the form easier to understand.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe: "Sometime designers propose not including visual field labels. However, most users prefer or even need visible labels to understand the form."
rationale: ... sorry, I've limited typing ability right now. happy to explain by voice.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I agree with your wording and have updated.

@@ -191,3 +191,6 @@ In the following example the link in the navigation points to the main content o
{::nomarkdown}
{% include box.html type="end" %}
{:/}

## Responsive Design
Menu structure should be consistent across screen sizes. Some menu items may be collapsed or even hidden in sub navigation menus, but items that show should appear in the same order and with the same wording and destination. Menus should be accessible by touch and keyboard.
Copy link
Contributor

Choose a reason for hiding this comment

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

Menus should be accessible by touch and keyboard.

seems like a separate point from the rest of the paragraph?
Should it be a separate paragraph?

Also, is it just related to "Responsive design" or more broadly?

And, does it need more explanation? e.g., If I'm using app on desktop, then does "touch" apply?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I presume it was included because a small screen size often means a mobile/touch device. I think it can actually be removed from here to keep things simple.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have removed that line.

@@ -191,3 +191,6 @@ In the following example the link in the navigation points to the main content o
{::nomarkdown}
{% include box.html type="end" %}
{:/}

## Responsive Design
Copy link
Contributor

Choose a reason for hiding this comment

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

looks like the tutorials are using sentence-style capitalization for headings, so:

Responsive design

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@@ -117,3 +117,6 @@ In the following example, a filled square is used for buttons associated with it
{:/}

{% include ednote.html note="The following paragraph was show in a side column before." %}A [working demo example](/tutorials/carousels/working-example/) for this code is available.

## For smaller screens
Copy link
Contributor

Choose a reason for hiding this comment

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

This also applies to people with large screens who use zoom. That makes it a direct accessibility issue. Is there a smooth way to include both?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added "/small viewports"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I revisited this and I don't think zoomed screens applies because we are talking about small text. The small text would be larger when zoomed (ideally)

@@ -117,3 +117,6 @@ In the following example, a filled square is used for buttons associated with it
{:/}

{% include ednote.html note="The following paragraph was show in a side column before." %}A [working demo example](/tutorials/carousels/working-example/) for this code is available.

## For smaller screens
Avoid use of text that is too small for easy reading or that is cut off. [Navigation buttons](https://www.w3.org/WAI/tutorials/carousels/functionality/#add-navigation-buttons) to control the slides should still be present to avoid the reliance on swipe gestures.
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid use of text that is too small for easy reading

This is so subjective, and of course is different for different people. I don’t know how to address it, though?

Navigation buttons to control the slides should still be present to avoid the reliance on swipe gestures.

Suggest re-wording this to active voice, e.g., maybe something like:

Make sure that navigation buttons to control the slides are available, since some people cannot use swipe gestures.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have updated the navigation button text, but am unsure how to update the small text comment.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I replaced "Avoid use of text that is too small for easy reading or that is cut off." with "Ensure all text is readable and not cut off or unnecessarily truncated."

@netlify
Copy link

netlify bot commented Jul 21, 2023

Deploy Preview for wai-tutorials2 ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/wai-tutorials2/deploys/662f91b9e55fa312ab71658d
😎 Deploy Preview https://deploy-preview-721--wai-tutorials2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@brianelton
Copy link
Collaborator Author

@shawna-slh do you have any further comments/suggestions before merging?

@shawna-slh
Copy link
Contributor

@shawna-slh do you have any further comments/suggestions before merging?

Sorry, I cannot find time to review all of this. Feel free to publish without my reviewing it. Or, if you have a specific question, let me know.

@brianelton brianelton added ready to merge PR is ready to merge but need to wait for appropriate time and removed EOWG Review labels Nov 9, 2023
@brianelton
Copy link
Collaborator Author

@shawna-slh please merge this PR.

@shawna-slh
Copy link
Contributor

Thanks Brian!
/me not able to make time to review. OK for @remibetin to merge and publish

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to merge PR is ready to merge but need to wait for appropriate time
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants