IBMa / equal-access

IBM Equal Access Accessibility Checker contains tools to automate accessibility checking from a browser or in a continuous development/build environment
Apache License 2.0
627 stars 81 forks source link

[Help] merge help for two rules being combined #1946

Closed philljenkins closed 1 month ago

philljenkins commented 1 month ago

Because we are merging input_placeholder_label_visible into the input_label_visible rule, the Help files need to be merged

The Help changes are related to the following rule changes:

1625 Revisit: input_placeholder_label_visible

1623 Revisit: input_label_visible

These rules map to the Requirements for 3.3.2 Labels or Instructions

See discussion note in Box

philljenkins commented 1 month ago

Existing Help files being merged:

philljenkins commented 1 month ago

New merged help:

Why is this important?

Visible labels are essential, so every user can know what information to enter:

Placeholder labels when used as the only visible label can reduce the accessibility for a wide range of users. Avoid placeholder labels for the following reasons:

Examples:

<label for="test1">License Number:</label>
    <input type="text" id="test1" aria-label="Enter driver license number"/>
<label for="test2">First name:</label>
    <input type="text" id="test2"/>
<label>Email Address: 
    <input type="email" name="address1" placeholder="john@example.net">
</label>

What to do

The intent of labels, including expected formats and required fields, on interactive elements is not to clutter the page with unnecessary information but to provide important cues that will benefit all users. Too much information can be just as harmful as too little.

If there is already a visible label for the element, use an attribute on the label to reference the element's id

If using the placeholder attribute, ensure it is a short hint to aid the user with data entry,

If a visible label cannot be added,

About this requirement

Who does this affect?

• People with cognitive, language, and learning disabilities • People with dexterity impairments using voice control • People with low vision using screen magnification • People with vision impairments needing contrast enhancement • People with tremors or other movement disorders using touch devices • Many older adults

philljenkins commented 1 month ago

Help pushed into dev-1623 and ready for review of PR 1944

philljenkins commented 1 month ago

After help and rules changes, the rule is correctly display in the Rule Set listing

image