[4.0] [a11y] add statement on found results

[hans2103]

Pull Request for Issue # .

Summary of Changes

With this PR I've added the total amount of search results and a link to the search results.
I am missing a statement about how many search results were found. I only get this information when no results are found.
When search results are found I would like to be able to click on it and jump directly to the results.

Testing Instructions

• Search for blog and see the results.

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

screenshot 1

When there are no results add a link to search again

screenshot 2

When there are results add a link to jump to the results. Just like a skip-link

[brianteeman]

what about giving the message a role="alert" ? that way it should result in the number of results being announced immediately on page load

[hans2103]

what about giving the message a role="alert" ? that way it should result in the number of results being announced immediately on page load

just wrote a new issue
#30536

@brianteeman I see you write role=alert while I was thinking about role=status
Which one is better?

[brianteeman]

You cant use status as that is for live regions ie parts of the page that are updated
In our case the page is reloaded and not updated

[hans2103]

thank you.

what about giving the message a role="alert" ?

Do you mean something like this:

$text = "no results OR one result OR x amount of results"
Factory::getApplication()->enqueueMessage($text, 'alert');

[brianteeman]

Sorry I used the word message incorrectly - i think

You can just put the role on the existing element - you dont need to use the enqueMessage as that creates a message at the top of the page (doesnt it?)

[hans2103]

@brianteeman I've added role=alert to the announcement of search results. It had to be added to the language strings.

COM_FINDER_QUERY_RESULTS="the following <a href=\"#search-result-list\" role=\"alert\">%s results were found</a>."
COM_FINDER_QUERY_RESULTS_0="<span role=\"alert\">no results were found</span>. <a href=\"#q\">Search again</a>."
COM_FINDER_QUERY_RESULTS_1="the following <span role=\"alert\">%s result was found</span>."

[brianteeman]

thats not going to work and its also not good practice to put markup inside a language string

this should work (not tested as I'm on my phone) . replace div if needed with any block element

<?php // Display the explained search query. ?>
		<div role="alert">
			<?php echo Text::sprintf('COM_FINDER_QUERY_TOKEN_INTERPRETED', $this->explained, Text::plural('COM_FINDER_QUERY_RESULTS', $this->total)); ?>
		</div>

[hans2103]

@brianteeman thank you for the feedback.
I've placed the text displayed in id="search-query-explained" in a paragraph element.

Assuming blog is required, the following 5 results were found.

<p role="alert">Assuming <span class="query-required"><span class="term">blog</span> is required</span>, the following <a href="#search-result-list">5 results were found</a>.</p>

[paternax]

I have tested this item ✅ successfully on 6eca68f

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30535.}

[hans2103]

@Quy and @brianteeman thank you for your contributions. I did some tests with plural to prevent the double strings. But it failed on my test. Now it seems to work and that makes me happy.
I have applied the suggested commits from @Quy.

[hans2103]

@Quy Thank you. How can the commit suggestions be applied to my PR?

[Quy]

@hans2103 There is a Commit suggestion button under the Suggested change code.

[hans2103]

@Quy thank you.. I was trying to merge the suggestions through the overview of changed files. But that didn't stick.
Now it seems to work. Thank you

[paternax]

I have tested this item ✅ successfully on 709eb8b

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30535.}

[ghost]

I have tested this item ✅ successfully on f7c9996

Works as shown in "Expected result AFTER applying this Pull Request".

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30535.}

[paternax]

I have tested this item ✅ successfully on f7c9996

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30535.}

[wilsonge]

Thanks!