Button docs should call out that an actual <button> should be used

Bug #1287826 reported by Stuart Langridge
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ubuntu HTML5 UI SDK
Fix Released
Undecided
Kyle Nitzsche
ubuntu-html5-theme (Ubuntu)
Fix Released
Undecided
Unassigned

Bug Description

http://developer.ubuntu.com/api/html5/sdk-14.04/UbuntuUI.Button/ shows using <button data-role="button">, which is correct, but should flag that an actual <button> should be used; this means that accessibility tools will recognise the button as a button without ARIA, and it's just generally bad practice to use a <div> as an interactable element.

Tags: docs

Related branches

Adnane Belmadiaf (daker)
tags: added: docs
Revision history for this message
Kyle Nitzsche (knitzsche) wrote :

I think the point of this bug is possibly clarifying that it should be <button data-role="button"...> not <div data-role="button">.

Are there any places where the docs say or recommend not using <button...>?

Revision history for this message
Pablo SEMINARIO (pabluk) wrote :
Revision history for this message
Kyle Nitzsche (knitzsche) wrote :

Pablo, thank you for pointing this out!

Changed in ubuntu-html5-theme:
status: New → Confirmed
Changed in ubuntu-html5-theme:
assignee: nobody → Kyle Nitzsche (knitzsche)
Revision history for this message
Kyle Nitzsche (knitzsche) wrote :

I just proposed MR to fix this and improve doc building by adding a script. As a bonus the new script includes the framework version and the bzr revision in the built html.

I am not sure how to make the MR appear hear in the usual way though, can anyone tell me?

Here's the MR anyway:
https://code.launchpad.net/~knitzsche/ubuntu-html5-theme/add-frameworkandbzrev-to-docs-and-bug1287826/+merge/210257

Changed in ubuntu-html5-theme:
status: Confirmed → In Progress
David Barth (dbarth)
Changed in ubuntu-html5-theme (Ubuntu):
status: New → Fix Committed
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ubuntu-html5-theme - 0.1.2+14.04.20140404-0ubuntu1

---------------
ubuntu-html5-theme (0.1.2+14.04.20140404-0ubuntu1) trusty; urgency=low

  [ Alexandre Abreu ]
  * Connect qmlengine quit signal to app quit slot (LP: #1299563)
  * Fix issues with the toolbar buttons: make sure that we dont
    preventDefault() in all cases (even when the user tries to
    click()),. make sure that the user's intent seems like
    hiding/showing before doing so,. (LP: #1222874)

  [ Adnane Belmadiaf ]
  * Removed unused locales.json

  [ David Barth ]
  * This branch aggregates 3 branches to help resolve SASS/CSS conflicts
    on the same file: merge of fix.1286362. merge of typography-update.
    merge of the fix.gallery-dialog branch .

  [ daker ]
  * Fixed toolbar declaration (LP: #1286833)
  * Adjust the content when the keyboard appears (LP: #1296463)

  [ Ubuntu daily release ]
  * New rebuild forced

  [ Kyle Nitzsche ]
  * 1) Fix lp bug https://bugs.launchpad.net/ubuntu-html5-
    theme/+bug/1241029 2) Improve doc building as follows: * add build
    script for docs: yuidoc-build.sh.(same as in unity-webapps-qml) *
    add docslib.py, used by yuidoc-build.sh to obtain bzr branch rev and
    insert it into yuidoc.json for use during build * add
    DOCSREADMET.txt: critical info about building docs * yuidoc.json:
    add majorversion field and set it to current framework: html-14.04-
    dev. The bzr branch rev is appended to this to create useful version
    field, which is consumed by yuidoc build and inserted into built
    html. As a result, the built index.html states the framework and the
    branch bzr rev as follows: "API Docs for: HTML-14.04-dev~bzr155"
    (LP: #1287826)
 -- Ubuntu daily release <email address hidden> Fri, 04 Apr 2014 14:12:11 +0000

Changed in ubuntu-html5-theme (Ubuntu):
status: Fix Committed → Fix Released
Changed in ubuntu-html5-theme:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.