From c27b61e10130b2f419398211f8b901d37325a0c9 Mon Sep 17 00:00:00 2001 From: Iisakki Rotko Date: Wed, 4 Sep 2024 15:06:17 +0200 Subject: [PATCH] docs: usability improvements to docs search - fixes a bug where the results box would show that a negative number more results exist - Keyboard navigation for results --- solara/website/components/algolia_api.vue | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/solara/website/components/algolia_api.vue b/solara/website/components/algolia_api.vue index e7a94acdc..6eb2ab842 100644 --- a/solara/website/components/algolia_api.vue +++ b/solara/website/components/algolia_api.vue @@ -15,7 +15,10 @@ ref="search" style="flex-grow: 1; max-width: 650px;" @click="show($event, on);" - @keyup.enter="item = 0" + @keyup.enter="hoverItem === null ? item = 0 : item = hoverItem" + @keyup.esc="close();" + @keyup.down="hoverItem = hoverItem == null ? 0 : Math.min(hoverItem + 1, results.hits.length - 1, 9)" + @keyup.up="hoverItem = hoverItem == null ? 9 : Math.max(hoverItem - 1, 0)" class="algolia" > @@ -28,7 +31,7 @@ - + {{ element.hierarchy.lvl1 }} @@ -40,7 +43,7 @@ - + And {{ this.results.nbHits - 10}} More... @@ -59,7 +62,6 @@ module.exports = { window.search = this; this.updateMenuWidth(); window.addEventListener('resize', this.updateMenuWidth); - }, watch: { query ( value ) { @@ -67,12 +69,17 @@ module.exports = { this.search(); }, item ( value ) { - if ( this.results.hits != null && this.results.hits.length > 0 ) { + if ( value === null ) return; + if ( this.results.hits != null && this.results.hits.length >= value ) { let url = this.results.hits[value].url; if (url.startsWith("https://solara.dev")) { url = url.slice(18); } solara.router.push( url ); + this.close(); + // reset the search + this.item = null; + this.hoverItem = null; } }, }, @@ -83,6 +90,10 @@ module.exports = { on.click( e ) } ); }, + close() { + this.show_results = false; + this.$refs.search.blur(); + }, initSearch() { this.client = this.algoliasearch( '9KW9L7O5EQ', '647ca12ba642437cc40c2adee4a78d08' ); this.index = this.client.initIndex( 'solara' ); @@ -177,6 +188,7 @@ module.exports = { query: '', results: [], item: null, + hoverItem: null, show_results: false, mac: false, menuWidth: 0,