Skip to content
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.

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

Shortcut to focus the "find label" input field #938

Merged
merged 17 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion resources/assets/js/annotations/annotatorContainer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,10 @@ export default {
selectLastAnnotation() {
let lastAnnotation = this.annotations.reduce((lastAnnotated, a) => a.id > lastAnnotated.id ? a : lastAnnotated, { id: 0 });
this.handleSelectAnnotation(lastAnnotation);
}
},
openSidebarLabels() {
this.$refs.sidebar.$emit('open', 'labels');
},
},
watch: {
async imageId(id) {
Expand Down
17 changes: 17 additions & 0 deletions resources/assets/js/annotations/components/labelsTab.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<script>
import LabelTrees from '../../label-trees/components/labelTrees';
import Keyboard from '../../core/keyboard';

/**
* Additional components that can be dynamically added by other Biigle modules via
Expand All @@ -23,8 +24,15 @@ export default {
return {
labelTrees: [],
selectedLabel: null,
focusInputFindlabel: false,
};
},
props: {
focusInput:{
type: Boolean,
default: false,
}
},
computed: {
plugins() {
return plugins;
Expand All @@ -39,9 +47,18 @@ export default {
this.selectedLabel = null;
this.$emit('select', null);
},
setFocusInputFindLabel() {
this.$emit('open', 'labels');
this.focusInputFindlabel = false;
this.$nextTick(() => {
this.focusInputFindlabel = true;
});
},
},
created() {
this.labelTrees = biigle.$require('annotations.labelTrees');

Keyboard.on('control+k', this.setFocusInputFindLabel, 0, this.listenerSet);
},
};
</script>
13 changes: 12 additions & 1 deletion resources/assets/js/label-trees/components/labelTrees.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="label-trees">
<div v-if="typeahead || clearable" class="label-trees__head">
<button v-if="clearable" @click="clear" class="btn btn-default" title="Clear selected labels" type="button"><span class="fa fa-times fa-fw" aria-hidden="true"></span></button>
<typeahead v-if="typeahead" :items="labels" more-info="tree.versionedName" @select="handleSelect" placeholder="Find label"></typeahead>
<typeahead ref="typeaheadInput" v-if="typeahead" :items="labels" more-info="tree.versionedName" @select="handleSelect" placeholder="Find label"></typeahead>
</div>
<div class="label-trees__body">
<label-tree v-if="hasFavourites" name="Favourites" :labels="favourites" :show-favourites="showFavourites" :flat="true" :showFavouriteShortcuts="true" :collapsible="collapsible" @select="handleSelect" @deselect="handleDeselect" @remove-favourite="handleRemoveFavourite"></label-tree>
Expand Down Expand Up @@ -73,6 +73,10 @@ export default {
type: String,
default: 'default',
},
focusInput:{
type: Boolean,
default: false,
}
},
computed: {
localeCompareSupportsLocales() {
Expand Down Expand Up @@ -192,7 +196,14 @@ export default {
});
},
},
focusInput() {
if (this.focusInput) {
this.$refs.typeaheadInput.$el.querySelector('input').focus();
}
}

},

mounted() {
if (this.showFavourites) {
let favouriteIds = JSON.parse(localStorage.getItem(this.favouriteStorageKey));
Expand Down
14 changes: 14 additions & 0 deletions resources/assets/js/videos/videoContainer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export default {
swappingLabel: false,
disableJobTracking: false,
supportsJumpByFrame: false,
focusInputFindlabel: false,
};
},
computed: {
Expand Down Expand Up @@ -677,6 +678,16 @@ export default {
selectLastAnnotation() {
let lastAnnotation = this.annotations.reduce((lastAnnotated, a) => a.id > lastAnnotated.id ? a : lastAnnotated, { id: 0 });
this.selectAnnotations([lastAnnotation], this.selectedAnnotations, lastAnnotation.startFrame);
},
openSidebarLabels() {
this.$refs.sidebar.$emit('open', 'labels');
this.setFocusInputFindLabel()
},
setFocusInputFindLabel() {
this.focusInputFindlabel = false;
this.$nextTick(() => {
this.focusInputFindlabel = true;
});
}
},
watch: {
Expand Down Expand Up @@ -742,6 +753,9 @@ export default {
if ("requestVideoFrameCallback" in HTMLVideoElement.prototype) {
this.supportsJumpByFrame = true;
}

Keyboard.on('control+k', this.openSidebarLabels, 0, this.listenerSet);

},
mounted() {
// Wait for the sub-components to register their event listeners before
Expand Down
4 changes: 2 additions & 2 deletions resources/views/annotations/show/tabs/labels.blade.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<sidebar-tab name="labels" icon="tags" title="Label trees">
<labels-tab v-on:select="handleSelectedLabel" v-cloak inline-template>
<labels-tab v-on:select="handleSelectedLabel" v-on:open="openSidebarLabels" v-cloak inline-template>
<div class="labels-tab">
<div class="labels-tab__trees">
<label-trees :trees="labelTrees" :show-favourites="true" v-on:select="handleSelectedLabel" v-on:deselect="handleDeselectedLabel" v-on:clear="handleDeselectedLabel"></label-trees>
<label-trees :trees="labelTrees" :show-favourites="true" :focus-input="focusInputFindlabel" v-on:select="handleSelectedLabel" v-on:deselect="handleDeselectedLabel" v-on:clear="handleDeselectedLabel"></label-trees>
</div>
<div class="labels-tab__plugins">
@mixin('annotationsLabelsTab')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@
<td><kbd>c</kbd></td>
<td>Select last created annotation</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd>+<kbd>k</kbd></td>
<td>Open label trees sidebar and focus the find label input field</td>
</tr>
</tbody>
</table>

Expand Down
4 changes: 4 additions & 0 deletions resources/views/manual/tutorials/videos/shortcuts.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@
<td><kbd>c</kbd></td>
<td>Select last created annotation</td>
</tr>
<tr>
<td><kbd>Ctrl</kbd>+<kbd>k</kbd></td>
<td>Open label trees sidebar and focus the find label input field</td>
</tr>
</tbody>
</table>

Expand Down
2 changes: 1 addition & 1 deletion resources/views/videos/show/sidebar-labels.blade.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<sidebar-tab name="labels" icon="tags" title="Label trees">
<div class="labels-tab">
<div class="labels-tab__trees">
<label-trees :trees="labelTrees" :show-favourites="true" v-on:select="handleSelectedLabel" v-on:deselect="handleDeselectedLabel" v-on:clear="handleDeselectedLabel"></label-trees>
<label-trees :trees="labelTrees" :focus-input="focusInputFindlabel" :show-favourites="true" v-on:select="handleSelectedLabel" v-on:deselect="handleDeselectedLabel" v-on:clear="handleDeselectedLabel"></label-trees>
</div>
</div>
</sidebar-tab>