Ex_doc: Show all the results for a empty search

[LauraBeatris]

Description

Should be possible to return all the results when searching for an empty value, instead of showing just a "Search" title.

Solution

The template should show a different title according to the search value.

For instance:

• A empty string: "All the results"
• A valid result: "Search results for {value}"

[josevalim]

Hi @LauraBeatris, thanks for the report!

I don't think we should show all results for an empty string. None of the search engines I tried show something. However, I agree whatever we do right now is not clear enough. Maybe we should add some information instead? For example "

Search

Please type something into the search bar to perform a search.

". Would this be clearer? Thanks!

[LauraBeatris]

@josevalim Yup! Makes more sense 😁

I'll send a PR with that modification

[eksperimental]

I think I reported this, but I cannot find It.
What I proposed, additionally to what you suggesting here, it to disable the submit button if no string has been entered.

[eksperimental]

I think I reported this, but I cannot find It.
What I proposed, additionally to what you suggesting here, it to disable the submit button if no string has been entered.

It was here: https://github.com/elixir-lang/ex_doc/issues/1204 item 3

[josevalim]

There is no submit button though. Should we ignore enter? That can be confusing to some... So I would prefer to just showing the page and not changing submit.

[LauraBeatris]

Would be cleaner to not modify the events and just show a different title and text.

The problem is that this title doesn't have a meaning

[josevalim]

Would be cleaner to not modify the events and just show a different title and text.

Agreed. Let's just add some extra text for now.

[eksperimental]

There is no submit button though. Should we ignore enter? That can be confusing to some... So I would prefer to just showing the page and not changing submit.

the magnifying glass is a <button type="submit" class="search-button">, but yeah. disabling hitting ENTER as well.
Even Google uses this behaviour.
Either way is fine with me.

[josevalim]

the magnifying glass is a , but yeah. disabling hitting ENTER as well.

Yeah, good call on Google doing it. So it means we are probably fine with doing it too. But let's discuss that separately. The page can still be rendered manually without a proper input.

[eksperimental]

Showing the instructions of how to use the search page. same as what you get when no results are found seems like a nice option to show.

[LauraBeatris]

Showing the instructions of how to use the search page. same as what you get when no results are found seems like a nice option to show.

Agreed! We should show the instructions too

What do you guys think?

[josevalim]

Looks great!

[eksperimental]

Looks good. If we can stress that it we are showing this due to no string being entered, would look even better. Either by using bold type in "Invalid search" or something. Just to make it look different from the "no results found" page.
Thank you.

[LauraBeatris]

Just made a PR https://github.com/elixir-lang/ex_doc/pull/1238