ISSUE-406: Proposal for new aria-hint property. (Previously proposed as @aria-help)

aria-hint

Proposal for new aria-hint property. (Previously proposed as @aria-help)

State:
CLOSED
Product:
ARIA 2.0
Raised by:
James Craig
Opened on:
2010-03-12
Description:
aria-hint (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-hint is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-hint may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-hint that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-hint if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Hint Computation

1. If the element has a non-empty "aria-hint" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-hint" attribute, (aria-hint=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-hint" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based hint, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute
Related Actions Items:
Related emails:
No related emails

Related notes:

Adding to ARIA 1.1 to consider with ISSUE-411

James Craig, 23 Jan 2014, 19:38:58

Stefan mentioned that we should also consider and aria-keyhelp property:

http://lists.w3.org/Archives/Public/public-pfwg/2014Feb/0001.html

Richard Schwerdtfeger, 3 Feb 2014, 14:33:31

I'm not entirely opposed to a special property for instructions, but it should not be called "keyhelp" because that would not apply to systems that could be used without a keyboard. aria-instructions maybe?

James Craig, 3 Feb 2014, 15:35:19

Closed with the creation of action 1390:

https://www.w3.org/WAI/PF/Group/track/actions/1390

Richard Schwerdtfeger, 2 Jul 2014, 13:20:15

[MichaelC]: consider whether this feature can also address the use case raised by issue-631

15 Sep 2014, 18:07:19

https://github.com/w3c/aria/issues/739

James Nurthen, 7 May 2018, 18:21:42

Changelog:

Created issue 'Proposal for new aria-help property.' nickname aria-help owned by James Craig on product ARIA 2.0, description 'Proposed wording for new aria-help property:

----

aria-help (property)

Defines a string value that provides complementary help information for the current element. Also see aria-label.

The purpose of aria-help is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-help may be, "Displays general preferences for the application, such as home page, history, and download preferences." Authors SHOULD NOT provide a value for aria-help if that information is already provided as all or part of the element's accessible name (label).

Related concepts:

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute

----

And for the help computation (new section under http://www.w3.org/WAI/PF/aria/complete#namecalculation ):

Help Computation

1. If the author has defined 'aria-help' on the element, user agents will expose the value of that attribute as the Help value in the accessibility API.
2. If the author has defined 'aria-help' as an empty string (""), user agents will expose no Help value in the accessibility API.
3. If the author has not defined 'aria-help', and if the author has defined a generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents will expose the value of the tooltip attribute as the Help value in the accessibility API.
' non-public

James Craig, 12 Mar 2010, 02:31:21

Product changed to ARIA 1.1

James Craig, 23 Jan 2014, 19:38:58

Status changed to 'open'

James Craig, 3 Feb 2014, 15:35:19

title changed to 'Proposal for new aria-tooltip property. (Previously proposed as @aria-help)'

James Craig, 17 Feb 2014, 19:39:56

nickname changed to 'aria-tooltip'

James Craig, 17 Feb 2014, 19:39:56

Description changed to 'Proposed wording for new aria-tooltip property:

----

aria-tooltip (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-help is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-help may be, "Displays general preferences for the application, such as home page, history, and download preferences." Authors SHOULD NOT provide a value for aria-help if that information is already provided as all or part of the element's accessible name (label).

Related concepts:

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute

----

And for the help computation (new section under http://www.w3.org/WAI/PF/aria/complete#namecalculation ):

Tooltip/Help Computation

1. If the author has defined 'aria-tooltip' on the element, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the author has defined 'aria-tooltip' as an empty string (""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the author has not defined 'aria-tooltip', and if the author has defined a generic tooltip attribute (such as @title in HTML), *and* if the tooltip attribute has NOT been used in the name computation for the element, user agents will expose the value of the tooltip attribute as the Tooltip/Help value in the accessibility API.'

James Craig, 17 Feb 2014, 19:39:56

Description changed to 'aria-tooltip (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-tooltip is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-help may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-tooltip that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-tooltip if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Tooltip/Help Computation

1. If the element has a non-empty "aria-tooltip" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-tooltip" attribute, (aria-tooltip=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-tooltip" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based tooltip, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute'

James Craig, 18 Feb 2014, 00:24:30

Description changed to 'aria-tooltip (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-tooltip is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-tooltip may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-tooltip that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-tooltip if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Tooltip/Help Computation

1. If the element has a non-empty "aria-tooltip" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-tooltip" attribute, (aria-tooltip=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-tooltip" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based tooltip, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute'

James Craig, 18 Feb 2014, 00:25:06

title changed to 'Proposal for new aria-hint/help/tooltip property. (Previously proposed as @aria-help)'

James Craig, 24 Feb 2014, 18:32:45

nickname changed to 'aria-hint/help/tooltip'

James Craig, 24 Feb 2014, 18:32:45

Description changed to 'aria-tooltip (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-hint is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-hint may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-hint that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-hint if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Hint/Tooltip/Help Computation

1. If the element has a non-empty "aria-tooltip" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-tooltip" attribute, (aria-tooltip=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-tooltip" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based tooltip, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute'

James Craig, 24 Feb 2014, 18:35:15

Description changed to 'aria-hint (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-hint is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-hint may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-hint that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-hint if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Hint/Tooltip/Help Computation

1. If the element has a non-empty "aria-tooltip" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-tooltip" attribute, (aria-tooltip=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-tooltip" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based tooltip, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute'

James Craig, 24 Feb 2014, 18:41:12

title changed to 'Proposal for new aria-hint property. (Previously proposed as @aria-help)'

James Craig, 24 Feb 2014, 18:44:58

nickname changed to 'aria-hint'

James Craig, 24 Feb 2014, 18:44:58

Description changed to 'aria-hint (property)

Defines a string value that provides complementary tooltip or help text information for the current element. Also see aria-label.

The purpose of aria-hint is to provide additional information that complements the label text. For example, if the visible label of a tab is "General", the value of aria-hint may be, "Displays general preferences for the application, such as home page, history, and download preferences."

Authors SHOULD NOT provide a value for aria-hint that duplicates information already provided as all or part of the element's accessible name (label). Authors SHOULD NOT provide a value for @aria-hint if that information is already provided using the host language’s tooltip attribute, such as @title in HTML.


Hint Computation

1. If the element has a non-empty "aria-hint" attribute, user agents will expose the value of that attribute as the Tooltip/Help value in the accessibility API.
2. If the element has an explicitly empty "aria-hint" attribute, (aria-hint=""), user agents will expose no Tooltip/Help value in the accessibility API.
3. If the element has no "aria-hint" attribute, but the "aria-describedby" attribute references a single element whose role is "tooltip", user agents must calculate the description using the text alternative algorithm and expose that string as the Tooltip/Help value in the accessibility API.
4. Otherwise, if there is no ARIA-based hint, and the element includes the generic tooltip attribute (such as @title in HTML), and if the tooltip attribute has NOT been used in the name computation for the element, user agents MUST expose the value of the tooltip attribute (e.g. @title in HTML) as the Tooltip/Help value in the accessibility API.


Related Concepts

Help Tag (Apple Human Interface Guidelines)
http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGUsingTechnologies/XHIGUsingTechnologies.html#//apple_ref/doc/uid/TP30000355-TPXREF9

AXHelp (Apple AX API)
http://developer.apple.com/mac/library/documentation/Accessibility/Reference/AccessibilityLowlevel/AXAttributeConstants_h/CompositePage.html#//apple_ref/c/macro/kAXHelpAttribute'

James Craig, 24 Feb 2014, 18:44:58

Status changed to 'closed'

Richard Schwerdtfeger, 2 Jul 2014, 13:20:15

Status changed to 'open'

Richard Schwerdtfeger, 10 Aug 2014, 15:53:47

Product changed to ARIA 2.0

James Craig, 31 Oct 2014, 22:01:08

Status changed to 'closed'

James Nurthen, 7 May 2018, 18:21:46


James Nurthen <nurthen@adobe.com>, Chair, Michael Cooper <cooper@w3.org>, Ruoxi Ran <ran@w3.org>, Staff Contacts
Tracker: documentation, (configuration for this group), originally developed by Dean Jackson, is developed and maintained by the Systems Team <w3t-sys@w3.org>.
$Id: index.php,v 1.326 2018/10/13 17:29:51 vivien Exp $