search

OfficeDev / xblock-officemix

MIT License
10 stars 9 forks source link

iframe element does not include title attribute #2

Open cptvitamin opened 9 years ago

cptvitamin commented 9 years ago

I reviewed this XBlock in my devstack and noticed that there is no title attribute on the <iframe /> element. The title attribute serves as the accessible label for an <iframe /> which gets presented to screen reader users when they navigate to the embed or when they list embedded elements or other navigable blocks/region on a page. I think it would be sufficient to use the "Component Display Name" as the value of the title attribute for this XBlock. It would also be helpful to reference this in the help text for "Component Display Name" i.e. "The name students see. This name appears in the course ribbon, as the accessible label, and as a header for the video."

More info:

kurtb commented 9 years ago

Great idea - we'll make sure to do that.

We're using oEmbed to get the embed code which leaves it up to the oEmbed provider (in this case Mix) to figure out the HTML to use to embed. Obviously we know the internal details, but it would be nice to not tweak what we get back.

We should in general have Mix be giving the iframe a title. Mixes already have a title so we could make use of that. But this may then end up differing from what the component gets called.

Any preference as far as what edX might prefer? Should the iframe title match the component display name? Or if it's different does that still work?

cptvitamin commented 9 years ago

HI @kurtb, ideally, it would be something like this: title="Office Mix: [Human readable title that describes the contents of the Mix]" so in the example Mix, it would be title="Office Mix: Office Mix XBlock - Embed Office Mix lectures within Open edX The part before the colon would be included for every Office Mix embed, the second half would be the human readable title. If the author doesn't set this in the Office Mix themselves, or its not available to edX at the point the iframe is rendered, perhaps they can define the title in Studio along with the URL of the Mix?