From 689aff2b259226b7d0b501e1913e3d06619a0107 Mon Sep 17 00:00:00 2001 From: Gia Ferrari Date: Sat, 31 Dec 2022 09:23:04 -0800 Subject: [PATCH] Document proposed alt_text properties. (#24990) * alt_text: picture, picture-entity, header-footer * Revert picture-entity alt_text prop; this feature will be revisited. * fix mistaken removal of endconfiguration directive * Improve wording of header-footer alt text property docs. Co-authored-by: Steve Repsher * Improve wording of picture alt text property docs. Co-authored-by: Steve Repsher * Add link to resource * Move up and add link to resource Co-authored-by: Steve Repsher --- source/_dashboards/picture.markdown | 4 ++++ source/dashboards/header-footer.markdown | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/source/_dashboards/picture.markdown b/source/_dashboards/picture.markdown index 17443ca9860..998119591b7 100644 --- a/source/_dashboards/picture.markdown +++ b/source/_dashboards/picture.markdown @@ -21,6 +21,10 @@ image: required: true description: "The URL of an image. When you want to store images in your Home Assistant installation use the [hosting files documentation](/integrations/http/#hosting-files). After storing your files, use the `/local` path, for example, `/local/filename.jpg`." type: string +alt_text: + required: false + description: Alternative text for the image. This is necessary for users of assistive technology. The [W3C images tutorial](https://www.w3.org/WAI/tutorials/images/) provides simple guidance for writing alternative text. + type: string theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/). diff --git a/source/dashboards/header-footer.markdown b/source/dashboards/header-footer.markdown index a3c0c586fdd..4458d7c1564 100644 --- a/source/dashboards/header-footer.markdown +++ b/source/dashboards/header-footer.markdown @@ -28,6 +28,10 @@ image: required: true description: The URL of an image. type: string +alt_text: + required: false + description: Alternative text for the image. This is necessary for users of assistive technology. The [W3C images tutorial](https://www.w3.org/WAI/tutorials/images/) provides simple guidance for writing alternative text. + type: string tap_action: required: false description: Action taken on card tap. See [action documentation](/dashboards/actions/#tap-action).