[#27650] - Media fields accessibility
- Closed
- 30 Jan 2020
- Medium
- Build: 4.0-dev
- Draft PR
- # 27650
- Diff
- astridx:media
- Pending Hound Hound is busy sniffing around... Details
User tests: Successful: Unsuccessful:
Pull Request for Issue #27571 .
Summary of Changes
I have integrated the possibility to enter an alternative text for a media field. This PR is a draft because it affects many other components. I haven't checked them all yet. I would like to know your opinion first.
Testing Instructions
- Apply this patch. The commands
npm cior/andcomposer iare not necessary. - Create two custom fields of type
mediain the content component. Chooseyesfor theAlternative text for imageoption andnofor the other.
- Edit an article that contains the two custom fields. You only see the text field where you chose to enter an alternative text.
- Look at the output in the front end. Once you see the alternative text you entered. The image, for which you could not enter any text, is also a11y compliant. Here is an empty alt text inserted.
- Since the media field is used in many places in Joomla, many places have to be adjusted. Therefore, this first 4 steps are not enough. Look for different places where the media field is used. For example, create a banner module with pictures, create a contact with a picture or an article with a picture. Always look at the output in the front end. Make sure the image is saved and dispayed correctly. Write it here in the issue if you find a place that is not correct.
- Make sure that the text field for entering an alternative text is not displayed in other fields than an custom field. So far, this alternative text has not yet been forwarded to the output in the front end, except for a custom field. Therefore, this would confuse an user. Usually there is an extra text field to use the alternative text.
Perhaps we should consider doing this uniformly in the future via the media field.
Documentation Changes Required
https://docs.joomla.org/J3.x:Adding_custom_fields/Media_Field
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_fields Language & Strings Layout Libraries Modules Front End Plugins |
This looks like a very complex solution given that media field can be complemented by an additional text field as is a already done in some components. The issue really only exists in the media custom field plugin and, IMO, should be fixed there.
all seems ok to me - thanks.
Some styling improvements but thats all I saw
@SharkyKZ Tthank you for your opinion
You are right, it is complicated and requires some rework. That's why it's a draft at first.
But
- I haven't seen an easier way to insert the alternate text in the custom field. Maybe I'm missing something there.
- And then I think that the alternative text belongs to the media field and my draft corrects it.
@brianteeman I like your suggestion to convert the selection field into a switch. If my draft gets a little more approval I will definitely change it.
| Labels |
Added:
?
?
|
||
I haven't seen an easier way to insert the alternate text in the custom field. Maybe I'm missing something there.
Custom field plugins have the ability to modify form's DOM content. So it's possible to change the media field into a subform field that contains media field and text field for alt attribute. This would still require data type checks to handle but at least they'd be limited to wherever custom fields are used.
And then I think that the alternative text belongs to the media field and my draft corrects it.
I don't necessarily disagree, but doing it this way is really messy. You need to account for both data types in every place its used. Currently this PR doesn't do that. The same thing would be needed by all 3rd party developers. It also seems wrong having to modify Joomla\CMS\HTML\HTMLHelper for this. In my opinion, this approach is not worth it.
Some other solutions to consider:
Modify media custom field plugin to use subform. Changes would be needed only in the custom field plugin and template overrides where fields are rendered manually.
Introduce a new field (e.g. Joomla\CMS\Form\Field\ImageField) and change type in media custom field plugin to this. Similar to using subform, changes limited to custom fields but eventually other extensions can be switched to this field.
Introduce a new field and a new custom field plugin. Making use of alt text requires users to edit fields in their content anyways, so might as well go a little further and have users create new fields to make use of the feature.
Final option, change data type only when the field is using alt text. This way existing extensions are not affected.
I was thinking on the lines of a subform myself until I saw this proposal.
I can't/won't comment on the code quality/complexity/maintainability of either approach as I am not qualified to do so
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2020-01-30 10:42:02 |
| Closed_By | ⇒ | astridx |
Awesome. I will check it tomorrow