Skip to content

Alt text for Images, Banners and Slides for better accessibility and SEO #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Dec 8, 2021
Merged

Alt text for Images, Banners and Slides for better accessibility and SEO #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5b4410f
Alt text for Images, Banners and Slides for better accessibility and SEO
manavluhar Oct 11, 2021
fec2eca
Covering new functionality with MFTF test
manavluhar Oct 17, 2021
1755d80
magento/magento2-page-builder#787: Tests stabilization
Oct 26, 2021
98b8d2f
magento/magento2-page-builder#787: Tests stabilization
Nov 12, 2021
a2fdc1d
Merge remote-tracking branch 'origin/develop' into manavluhar/seo
Nov 12, 2021
dbf8e0e
magento/magento2-page-builder#787: Moved attributes to different level
Nov 23, 2021
ef04b0c
magento/magento2-page-builder#787: Moved attributes to different level
Nov 23, 2021
be616c3
magento/magento2-page-builder#787: Moved attributes to different level
Nov 23, 2021
7217281
magento/magento2-page-builder#787: Fixed test
Nov 24, 2021
6ea28dd
magento/magento2-page-builder#787: Fixed issue with attributes
Nov 29, 2021
7ad0204
Merge remote-tracking branch 'origin/develop' into manavluhar/seo
Nov 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions app/code/Magento/PageBuilder/Test/Mftf/Data/BannerData.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,4 +235,18 @@
<data key="value">rgba(174, 198, 207, 0.7)</data>
<data key="rgb">rgba(174, 198, 207, 0.7)</data>
</entity>
<!-- Banner Alt Text -->
<entity name="PageBuilderBannerAltTextProperty" type="pagebuilder_alt_text_property">
<data key="name">Alternative Text</data>
<data key="section">seo</data>
<data key="fieldName">alt</data>
<data key="value">This is alternative text.</data>
</entity>
<!-- Banner Title Attribute -->
<entity name="PageBuilderBannerTitleAttributeProperty" type="pagebuilder_title_attribute_property">
<data key="name">Title Attribute</data>
<data key="section">seo</data>
<data key="fieldName">title_attribute</data>
<data key="value">This is a Title Attribute</data>
</entity>
</entities>
14 changes: 14 additions & 0 deletions app/code/Magento/PageBuilder/Test/Mftf/Data/SlideData.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,4 +254,18 @@
<data key="errorMessage">Adding widget in content and link in outer element is not allowed.</data>
<data key="stageErrorMessage">We are unable to support widget within the content field whilst having a link set on the content type. Please remove the content type link if you'd like to set a widget within the content. We will automatically remove the widget within the content field.</data>
</entity>
<!-- Slide Alt Text -->
<entity name="PageBuilderSlideAltTextProperty" type="pagebuilder_alt_text_property">
<data key="name">Alternative Text</data>
<data key="section">seo</data>
<data key="fieldName">alt</data>
<data key="value">This is alternative text.</data>
</entity>
<!-- Slide Title Attribute -->
<entity name="PageBuilderSlideTitleAttributeProperty" type="pagebuilder_title_attribute_property">
<data key="name">Title Attribute</data>
<data key="section">seo</data>
<data key="fieldName">title_attribute</data>
<data key="value">This is a Title Attribute</data>
</entity>
</entities>
2 changes: 2 additions & 0 deletions ...Magento/PageBuilder/Test/Mftf/Section/PageBuilderBannerSection/BannerOnBackendSection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
<element name="wysiwygLinkUrl" type="button" selector="(//div[contains(@class,'pagebuilder-banner') and contains(@class,'pagebuilder-content-type')])[{{bannerIndex}}]//a[@href='{{link}}']" parameterized="true"/>
<element name="imageOnStage" type="text" selector="(//div[contains(@class,'pagebuilder-banner') and contains(@class,'pagebuilder-content-type')])[{{bannerIndex}}]//img[contains(@src,'{{image}}')]" parameterized="true"/>
<element name="imageSourceByIndex" type="text" selector="(//div[@data-content-type='banner'])[{{bannerIndex}}]/div[contains(@data-background-images,'{{image}}')]" parameterized="true"/>
<element name="bannerAltText" type="text" selector="(//div[@data-content-type='banner'])[{{arg1}}]//div[@aria-label='{{arg2}}']" parameterized="true"/>
<element name="bannerTitleAttribute" type="text" selector="(//div[@data-content-type='banner'])[{{arg1}}]//div[@title='{{arg2}}']" parameterized="true"/>
<element name="uploadImageInput" type="button" selector="//div[contains(@class,'pagebuilder-image-uploader-container')]//input[@name='background_image']"/>
<element name="variablePlaceholder" type="text" selector="(//div[contains(@class,'pagebuilder-banner')])[{{bannerIndex}}]//*[contains(@class, 'magento-variable') and contains(@class, 'magento-placeholder')]" parameterized="true"/>
<element name="widgetPlaceholder" type="text" selector="(//div[contains(@class,'pagebuilder-banner')])[{{bannerIndex}}]//*[contains(@class, 'magento-placeholder') and contains(@class, 'magento-widget')]" parameterized="true"/>
Expand Down
2 changes: 2 additions & 0 deletions ...agento/PageBuilder/Test/Mftf/Section/PageBuilderBannerSection/BannerOnFrontendSection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
<element name="overlay" type="button" selector="(//div[@data-content-type=&quot;banner&quot;])[{{bannerIndex}}]//div[@data-element=&quot;overlay&quot;]" parameterized="true"/>
<element name="overlayJS" type="button" selector="document.querySelectorAll('[data-content-type=banner] div.pagebuilder-overlay')[{{overlayIndex}} - 1]" parameterized="true"/>
<element name="wysiwygLinkUrl" type="button" selector="(//div[@data-content-type='banner'])[{{bannerIndex}}]//div[@data-element='wrapper']//a[@href='{{link}}']" parameterized="true"/>
<element name="bannerAltText" type="button" selector="(//div[@data-content-type='banner'])[{{arg1}}]//div[@aria-label='{{arg2}}']" parameterized="true"/>
<element name="bannerTitleAttribute" type="button" selector="(//div[@data-content-type='banner'])[{{arg1}}]//div[@title='{{arg2}}']" parameterized="true"/>
<!-- Appearance Configuration -->
<element name="appearance" type="text" selector="(//div[@data-content-type='banner'])[{{bannerIndex}}][@data-appearance='{{appearance}}']" parameterized="true"/>
<element name="appearancePosterCSS" type="button" selector="[data-content-type=banner][data-appearance=poster]"/>
Expand Down
2 changes: 2 additions & 0 deletions .../Magento/PageBuilder/Test/Mftf/Section/PageBuilderSliderSection/SlideOnBackendSection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
<element name="overlayJS" type="button" selector="document.querySelectorAll('[data-content-type=slider] div.pagebuilder-overlay')[{{slideOverlayIndex}} - 1]" parameterized="true"/>
<element name="editableButtonItemElement" type="button" selector="(//div[@data-content-type='slide'])[{{slideIndex}}]//a[@data-element='button']//span[contains(@contenteditable, 'true')]" parameterized="true"/>
<element name="imageSourceByIndex" type="text" selector="(//div[@data-content-type='slide'])[{{slideIndex}}]/div[contains(@data-background-images,'{{image}}')]" parameterized="true" deprecated="Styles are not inline"/>
<element name="slideAltText" type="text" selector="(//div[@data-content-type='slide'])[{{arg1}}]//div[@aria-label='{{arg2}}']" parameterized="true"/>
<element name="slideTitleAttribute" type="text" selector="(//div[@data-content-type='slide'])[{{arg1}}]//div[@title='{{arg2}}']" parameterized="true"/>
<element name="openOptionsMenu" type="button" selector="(//div[contains(@class,'navigation-dot')])[{{navigationDotIndex}}]" parameterized="true"/>
<element name="optionsMenu" type="button" selector="(//div[contains(@class,'navigation-dot')])[{{navigationDotIndex}}]//div[@class='pagebuilder-options-wrapper']" parameterized="true"/>
<element name="optionsMenuButton" type="button" selector="(//div[contains(@class,'navigation-dot')])[{{navigationDotIndex}}]//li[contains(@class,'pagebuilder-options-link')]//a[contains(@class,'{{buttonClass}}')]" parameterized="true"/>
Expand Down
2 changes: 2 additions & 0 deletions ...Magento/PageBuilder/Test/Mftf/Section/PageBuilderSliderSection/SlideOnFrontendSection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
<element name="slickSlideIndex" type="text" selector="[data-slick-index='{{slickSlideIndex}}']" parameterized="true"/>
<element name="computedBoxSizing" type="button" selector="return window.getComputedStyle(document.querySelector('[data-content-type=slide]')).boxSizing"/>
<element name="wysiwygLinkUrl" type="button" selector="(//div[@data-content-type='slide'])[{{slideIndex}}]//div[@data-element='wrapper']//a[@href='{{link}}']" parameterized="true"/>
<element name="slideAltText" type="button" selector="(//div[@data-content-type='slide'])[{{arg1}}]//div[@aria-label='{{arg2}}']" parameterized="true"/>
<element name="slideTitleAttribute" type="button" selector="(//div[@data-content-type='slide'])[{{arg1}}]//div[@title='{{arg2}}']" parameterized="true"/>
<!-- Appearance Configuration -->
<element name="appearance" type="text" selector="(//div[@data-content-type='slide'])[{{slideIndex}}][@data-appearance='{{appearance}}']" parameterized="true"/>
<element name="slideName" type="button" selector="(//div[@data-content-type='slide'])[{{slideIndex}}][@data-slide-name='{{slideName}}']" parameterized="true"/>
Expand Down
8 changes: 8 additions & 0 deletions ...o/PageBuilder/Test/Mftf/Test/AdminPageBuilderBannerCommonTest/BannerHasNoRequiredTest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@
<actionGroup ref="openPageBuilderEditPanel" stepKey="openEditMenuOnStage">
<argument name="contentType" value="PageBuilderBannerContentType"/>
</actionGroup>
<!-- Clear Fields -->
<comment userInput="Clear Fields" stepKey="commentClearFields"/>
<actionGroup ref="clearSlideOutPanelFieldGeneral" stepKey="clearAltText">
<argument name="property" value="PageBuilderBannerAltTextProperty"/>
</actionGroup>
<actionGroup ref="clearSlideOutPanelFieldGeneral" stepKey="clearTitleAttr">
<argument name="property" value="PageBuilderBannerTitleAttributeProperty"/>
</actionGroup>
<dontSeeElement selector="{{EditPanelForm.editFormAllRequiredFields}}" stepKey="checkNoRequiredField"/>
</test>
</tests>
14 changes: 14 additions & 0 deletions ...derMediaContentTypesTest/BlockRenderBannerPosterAppearanceThroughBlockContentTypeTest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,21 @@
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="setOverlayColor">
<argument name="property" value="PageBuilderBannerOverlayColor_Blue_Opaque"/>
</actionGroup>
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="enterAltText">
<argument name="property" value="PageBuilderBannerAltTextProperty"/>
</actionGroup>
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="enterTitleAttribute">
<argument name="property" value="PageBuilderBannerTitleAttributeProperty"/>
</actionGroup>
<actionGroup ref="saveEditPanelSettings" stepKey="saveEditPanelSettings"/>
<actionGroup ref="exitPageBuilderFullScreen" stepKey="exitPageBuilderFullScreenBeforeSave"/>
<actionGroup ref="SaveCMSBlockActionGroup" stepKey="saveCMSBlock"/>
<actionGroup ref="AdminOpenPageBuilderFromContentPreviewOverlayActionGroup" stepKey="openPageBuilderFullScreen"/>
<!-- Validate CMS Block Stage -->
<comment userInput="Validate CMS Block Stage" stepKey="commentValidateCMSBlockStage"/>
<seeElement selector="{{BannerOnBackend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSBlockStage"/>
<seeElement selector="{{BannerOnBackend.bannerAltText('1', PageBuilderBannerAltTextProperty.value)}}" stepKey="seeBannerAltTextCMSBlockStage"/>
<seeElement selector="{{BannerOnBackend.bannerTitleAttribute('1', PageBuilderBannerTitleAttributeProperty.value)}}" stepKey="seeBannerTitleAttributeCMSBlockStage"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSBlockStage">
<argument name="page" value="BannerOnBackend"/>
<argument name="padding" value="PageBuilderPaddingProperty0"/>
Expand Down Expand Up @@ -202,6 +210,8 @@
<!-- Validate CMS Page Stage -->
<comment userInput="Validate CMS Page Stage" stepKey="commentValidateCMSPageStage"/>
<seeElement selector="{{BannerOnFrontend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSPageStage"/>
<seeElement selector="{{BannerOnFrontend.bannerAltText('1', PageBuilderBannerAltTextProperty.value)}}" stepKey="seeBannerAltTextCMSPageStage"/>
<seeElement selector="{{BannerOnFrontend.bannerTitleAttribute('1', PageBuilderBannerTitleAttributeProperty.value)}}" stepKey="seeBannerTitleAttributeCMSPageStage"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSPageStage">
<argument name="page" value="BannerOnFrontend"/>
<argument name="padding" value="PageBuilderPaddingProperty0"/>
Expand Down Expand Up @@ -255,6 +265,8 @@
<argument name="page" value="$$createCMSPage.identifier$$"/>
</actionGroup>
<seeElement selector="{{BannerOnFrontend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSPageStorefront"/>
<seeElement selector="{{BannerOnFrontend.bannerAltText('1', PageBuilderBannerAltTextProperty.value)}}" stepKey="seeBannerAltTextCMSPageStorefront"/>
<seeElement selector="{{BannerOnFrontend.bannerTitleAttribute('1', PageBuilderBannerTitleAttributeProperty.value)}}" stepKey="seeBannerTitleAttributeCMSPageStorefront"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSPageStorefront">
<argument name="page" value="BannerOnFrontend"/>
<argument name="padding" value="PageBuilderPaddingProperty0"/>
Expand Down Expand Up @@ -321,6 +333,8 @@
<actionGroup ref="NavigateToStorefrontForCreatedPageActionGroup" stepKey="navigateToCMSPageStoreFrontMobile">
<argument name="page" value="$$createCMSPage.identifier$$"/>
</actionGroup>
<seeElement selector="{{BannerOnFrontend.bannerAltText('1', PageBuilderBannerAltTextProperty.value)}}" stepKey="seeBannerAltTextCMSPageStorefrontMobile"/>
<seeElement selector="{{BannerOnFrontend.bannerTitleAttribute('1', PageBuilderBannerTitleAttributeProperty.value)}}" stepKey="seeBannerTitleAttributeCMSPageStorefrontMobile"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSPageStorefrontMobile">
<argument name="page" value="BannerOnFrontend"/>
<argument name="padding" value="PageBuilderPaddingProperty0"/>
Expand Down
16 changes: 15 additions & 1 deletion ...MediaContentTypesTest/BlockRenderSlideItemPosterAppearanceThroughBlockContentTypeTest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="setSlideName">
<argument name="property" value="PageBuilderSlideItemSlideName_Slide1"/>
</actionGroup>
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="enterAltText">
<argument name="property" value="PageBuilderSlideAltTextProperty"/>
</actionGroup>
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="enterTitleAttribute">
<argument name="property" value="PageBuilderSlideTitleAttributeProperty"/>
</actionGroup>
<actionGroup ref="fillSlideOutPanelFieldGeneral" stepKey="setMinHeight">
<argument name="property" value="PageBuilderMinHeightProperty_500px"/>
</actionGroup>
Expand Down Expand Up @@ -123,6 +129,8 @@
<comment userInput="Validate CMS Block Stage" stepKey="commentValidateCMSBlockStage"/>
<click selector="{{PageBuilderPanel.searchPanel}}" stepKey="unfocusSlideOptions"/>
<seeElement selector="{{SlideOnBackend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSBlockStage"/>
<seeElement selector="{{SlideOnBackend.slideAltText('1', PageBuilderSlideAltTextProperty.value)}}" stepKey="seeSlideAltTextCMSBlockStage"/>
<seeElement selector="{{SlideOnBackend.slideTitleAttribute('1', PageBuilderSlideTitleAttributeProperty.value)}}" stepKey="seeSlideTitleAttributeCMSBlockStage"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSBlockStage">
<argument name="page" value="SlideOnBackend"/>
</actionGroup>
Expand Down Expand Up @@ -205,6 +213,8 @@
<!-- Validate CMS Page Stage -->
<comment userInput="Validate CMS Page Stage" stepKey="commentValidateCMSPageStage"/>
<seeElement selector="{{SlideOnFrontend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSPageStage"/>
<seeElement selector="{{SlideOnFrontend.slideAltText('1', PageBuilderSlideAltTextProperty.value)}}" stepKey="seeSlideAltTextCMSPageStage"/>
<seeElement selector="{{SlideOnFrontend.slideTitleAttribute('1', PageBuilderSlideTitleAttributeProperty.value)}}" stepKey="seeSlideTitleAttributeCMSPageStage"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSPageStage">
<argument name="page" value="SlideOnFrontend"/>
</actionGroup>
Expand Down Expand Up @@ -256,6 +266,8 @@
<argument name="page" value="$$createCMSPage.identifier$$"/>
</actionGroup>
<seeElement selector="{{SlideOnFrontend.appearance('1', PageBuilderAppearance_Poster.value)}}" stepKey="seeAppearanceCMSPageStorefront"/>
<seeElement selector="{{SlideOnFrontend.slideAltText('1', PageBuilderSlideAltTextProperty.value)}}" stepKey="seeSlideAltTextCMSPageStorefront"/>
<seeElement selector="{{SlideOnFrontend.slideTitleAttribute('1', PageBuilderSlideTitleAttributeProperty.value)}}" stepKey="seeSlideTitleAttributeCMSPageStorefront"/>
<actionGroup ref="validateOverlayPositionPoster" stepKey="validateOverlayPositionCMSPageStorefront">
<argument name="page" value="SlideOnFrontend"/>
</actionGroup>
Expand Down Expand Up @@ -332,6 +344,8 @@
<argument name="section" value="SlideOnFrontend"/>
<argument name="backgroundImage" value="PageBuilderBackgroundMobileImage_GIF"/>
</actionGroup>
<seeElement selector="{{SlideOnFrontend.slideAltText('1', PageBuilderSlideAltTextProperty.value)}}" stepKey="seeSlideAltTextCMSPageStorefrontMobile"/>
<seeElement selector="{{SlideOnFrontend.slideTitleAttribute('1', PageBuilderSlideTitleAttributeProperty.value)}}" stepKey="seeSlideTitleAttributeCMSPageStorefrontMobile"/>
<seeElementInDOM selector="{{SlideOnFrontend.button('1')}}" stepKey="seeButtonInDOMCMSPageStorefrontMobile"/>
<dontSeeElement selector="{{SlideOnFrontend.button('1')}}" stepKey="dontSeeButtonCMSPageStorefrontMobile"/>
<actionGroup ref="ValidateContentTypesStyleEqualsExpectedStyleActionGroup" stepKey="seeTransparentOverlayCMSPageStorefrontMobile">
Expand All @@ -353,4 +367,4 @@
<wait time="3" stepKey="waitArbitraryTimeForPotentialNavigationToOccurCMSPageStorefrontMobile"/>
<seeCurrentUrlEquals url="{{PageBuilderSlideItemLinkURL_External.value}}" stepKey="seeThatUrlIsChangedToButtonUrlCMSPageStorefrontMobile"/>
</test>
</tests>
</tests>
Loading