Skip to content

Commit

Permalink
docs: usability improvements to docs search (#770)
Browse files Browse the repository at this point in the history
- fixes a bug where the results box would show that a negative number more results exist
- Keyboard navigation for results
  • Loading branch information
iisakkirotko authored Sep 12, 2024
1 parent 8928edc commit aa871a3
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions solara/website/components/algolia_api.vue
Original file line number Diff line number Diff line change
Expand Up @@ -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"
></v-text-field>
</template>
Expand All @@ -28,7 +31,7 @@
</v-list>
<v-list v-else :style="{width: menuWidth + 'px'}">
<v-list-item-group v-model="item">
<v-list-item v-for="(element, index) in this.results.hits" :key="element['url']">
<v-list-item v-for="(element, index) in this.results.hits" :key="element['url']" :input-value="index === hoverItem">
<v-list-item-content>
<v-list-item-title>
{{ element.hierarchy.lvl1 }}
Expand All @@ -40,7 +43,7 @@
</v-list-item-content>
</v-list-item>
</v-list-item-group>
<v-list-item>
<v-list-item v-if="this.results.nbHits > 10">
<v-list-item-content>
<v-list-item-title>And {{ this.results.nbHits - 10}} More...</v-list-item-title>
</v-list-item-content>
Expand All @@ -59,20 +62,24 @@ module.exports = {
window.search = this;
this.updateMenuWidth();
window.addEventListener('resize', this.updateMenuWidth);
},
watch: {
query ( value ) {
this.show_results = true;
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;
}
},
},
Expand All @@ -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' );
Expand Down Expand Up @@ -177,6 +188,7 @@ module.exports = {
query: '',
results: [],
item: null,
hoverItem: null,
show_results: false,
mac: false,
menuWidth: 0,
Expand Down

0 comments on commit aa871a3

Please sign in to comment.