mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-02 19:49:58 +00:00
## Summary Adds an educational hint to the favorites empty state to teach users how to favorite inputs. ## Changes - Add new i18n key `favoritesNoneHint` with text "In the Parameters tab, click ⋮ on any input to add it here" - Update empty state template to show hint below the existing description - Hint is hidden during search to avoid redundant messaging ## Before/After **Before:** "Inputs you favorite will show up here" **After:** - "Inputs you favorite will show up here" - "In the Parameters tab, click ⋮ on any input to add it here* ## Context Per Slack discussion, uses in-app education only (no external docs link) to ensure text matches the user's specific version of the feature. Fixes #2fa6d73d ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-8559-feat-Add-educational-hint-to-favorites-empty-state-2fc6d73d365081f5827dfafcc1ece95c) by [Unito](https://www.unito.io) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Improved empty state in the Parameters panel: message is now two paragraphs and shows an additional hint (with an icon) when not searching. * **Localization** * Added a new localized hint that explains how to add inputs to favorites, shown in the Parameters panel empty state. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Rizumu Ayaka <rizumu@ayaka.moe>
160 lines
4.5 KiB
Vue
160 lines
4.5 KiB
Vue
<script setup lang="ts">
|
|
import { useMounted, watchDebounced } from '@vueuse/core'
|
|
import { storeToRefs } from 'pinia'
|
|
import {
|
|
computed,
|
|
nextTick,
|
|
onBeforeUnmount,
|
|
onMounted,
|
|
ref,
|
|
shallowRef
|
|
} from 'vue'
|
|
import { useI18n } from 'vue-i18n'
|
|
|
|
import FormSearchInput from '@/renderer/extensions/vueNodes/widgets/components/form/FormSearchInput.vue'
|
|
import { DraggableList } from '@/scripts/ui/draggableList'
|
|
import { useFavoritedWidgetsStore } from '@/stores/workspace/favoritedWidgetsStore'
|
|
import type { ValidFavoritedWidget } from '@/stores/workspace/favoritedWidgetsStore'
|
|
import { useRightSidePanelStore } from '@/stores/workspace/rightSidePanelStore'
|
|
|
|
import { searchWidgets } from '../shared'
|
|
import SectionWidgets from './SectionWidgets.vue'
|
|
|
|
const favoritedWidgetsStore = useFavoritedWidgetsStore()
|
|
const rightSidePanelStore = useRightSidePanelStore()
|
|
const { searchQuery } = storeToRefs(rightSidePanelStore)
|
|
const { t } = useI18n()
|
|
|
|
const draggableList = ref<DraggableList | undefined>(undefined)
|
|
const sectionWidgetsRef = ref<{ widgetsContainer: HTMLElement }>()
|
|
const isSearching = ref(false)
|
|
|
|
const favoritedWidgets = computed(
|
|
() => favoritedWidgetsStore.validFavoritedWidgets
|
|
)
|
|
|
|
const label = computed(() =>
|
|
favoritedWidgets.value.length === 0
|
|
? t('rightSidePanel.favoritesNone')
|
|
: t('rightSidePanel.favorites')
|
|
)
|
|
|
|
const searchedFavoritedWidgets = shallowRef<ValidFavoritedWidget[]>(
|
|
favoritedWidgets.value
|
|
)
|
|
|
|
async function searcher(query: string) {
|
|
isSearching.value = query.trim().length > 0
|
|
searchedFavoritedWidgets.value = searchWidgets(favoritedWidgets.value, query)
|
|
}
|
|
|
|
const isMounted = useMounted()
|
|
|
|
function setDraggableState() {
|
|
if (!isMounted.value) return
|
|
draggableList.value?.dispose()
|
|
const container = sectionWidgetsRef.value?.widgetsContainer
|
|
if (isSearching.value || !container?.children?.length) return
|
|
|
|
draggableList.value = new DraggableList(container, '.draggable-item')
|
|
|
|
draggableList.value.applyNewItemsOrder = function () {
|
|
const reorderedItems: HTMLElement[] = []
|
|
|
|
let oldPosition = -1
|
|
this.getAllItems().forEach((item, index) => {
|
|
if (item === this.draggableItem) {
|
|
oldPosition = index
|
|
return
|
|
}
|
|
if (!this.isItemToggled(item)) {
|
|
reorderedItems[index] = item
|
|
return
|
|
}
|
|
const newIndex = this.isItemAbove(item) ? index + 1 : index - 1
|
|
reorderedItems[newIndex] = item
|
|
})
|
|
|
|
for (let index = 0; index < this.getAllItems().length; index++) {
|
|
const item = reorderedItems[index]
|
|
if (typeof item === 'undefined') {
|
|
reorderedItems[index] = this.draggableItem as HTMLElement
|
|
}
|
|
}
|
|
|
|
const newPosition = reorderedItems.indexOf(
|
|
this.draggableItem as HTMLElement
|
|
)
|
|
const widgets = [...searchedFavoritedWidgets.value]
|
|
const [widget] = widgets.splice(oldPosition, 1)
|
|
widgets.splice(newPosition, 0, widget)
|
|
searchedFavoritedWidgets.value = widgets
|
|
favoritedWidgetsStore.reorderFavorites(widgets)
|
|
}
|
|
}
|
|
|
|
watchDebounced(
|
|
searchedFavoritedWidgets,
|
|
() => {
|
|
setDraggableState()
|
|
},
|
|
{ debounce: 100 }
|
|
)
|
|
|
|
onMounted(() => {
|
|
setDraggableState()
|
|
})
|
|
|
|
onBeforeUnmount(() => {
|
|
draggableList.value?.dispose()
|
|
})
|
|
</script>
|
|
|
|
<template>
|
|
<div class="px-4 pt-1 pb-4 flex gap-2 border-b border-interface-stroke">
|
|
<FormSearchInput
|
|
v-model="searchQuery"
|
|
:searcher
|
|
:update-key="favoritedWidgets"
|
|
/>
|
|
</div>
|
|
<SectionWidgets
|
|
ref="sectionWidgetsRef"
|
|
:label
|
|
:widgets="searchedFavoritedWidgets"
|
|
:is-draggable="!isSearching"
|
|
hidden-favorite-indicator
|
|
show-node-name
|
|
enable-empty-state
|
|
class="border-b border-interface-stroke"
|
|
@update:collapse="nextTick(setDraggableState)"
|
|
>
|
|
<template #empty>
|
|
<div class="text-sm text-muted-foreground px-4 text-center py-10">
|
|
<p>
|
|
{{
|
|
isSearching
|
|
? t('rightSidePanel.noneSearchDesc')
|
|
: t('rightSidePanel.favoritesNoneDesc')
|
|
}}
|
|
</p>
|
|
<i18n-t
|
|
v-if="!isSearching"
|
|
keypath="rightSidePanel.favoritesNoneHint"
|
|
tag="p"
|
|
class="mt-2 text-xs"
|
|
>
|
|
<template #moreIcon>
|
|
<span
|
|
aria-hidden="true"
|
|
class="inline-flex size-5 items-center justify-center rounded-md bg-secondary-background-hover text-secondary-foreground align-middle"
|
|
>
|
|
<i class="icon-[lucide--more-vertical] text-sm" />
|
|
</span>
|
|
</template>
|
|
</i18n-t>
|
|
</div>
|
|
</template>
|
|
</SectionWidgets>
|
|
</template>
|