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

Enable category-based narrowing and reset to default on search clear #2071

Merged
merged 3 commits into from
Dec 27, 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
92 changes: 63 additions & 29 deletions src/components/dialog/content/SettingDialogContent.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@
:options="categories"
optionLabel="translatedLabel"
scrollHeight="100%"
:disabled="inSearch"
:optionDisabled="
(option: SettingTreeNode) =>
inSearch && !searchResultsCategories.has(option.label)
"
class="border-none w-full"
/>
</ScrollPanel>
Expand Down Expand Up @@ -70,7 +73,11 @@ import Tabs from 'primevue/tabs'
import TabPanels from 'primevue/tabpanels'
import Divider from 'primevue/divider'
import ScrollPanel from 'primevue/scrollpanel'
import { SettingTreeNode, useSettingStore } from '@/stores/settingStore'
import {
getSettingInfo,
SettingTreeNode,
useSettingStore
} from '@/stores/settingStore'
import { ISettingGroup, SettingParams } from '@/types/settingTypes'
import SearchBox from '@/components/common/SearchBox.vue'
import SettingsPanel from './setting/SettingsPanel.vue'
Expand Down Expand Up @@ -153,19 +160,14 @@ const categories = computed<SettingTreeNode[]>(() =>
)

const activeCategory = ref<SettingTreeNode | null>(null)
const searchResults = ref<ISettingGroup[]>([])

watch(activeCategory, (newCategory, oldCategory) => {
if (newCategory === null) {
activeCategory.value = oldCategory
}
})

onMounted(() => {
activeCategory.value = props.defaultPanel
const getDefaultCategory = () => {
return props.defaultPanel
? categories.value.find((x) => x.key === props.defaultPanel) ??
categories.value[0]
categories.value[0]
: categories.value[0]
}
onMounted(() => {
activeCategory.value = getDefaultCategory()
})

const sortedGroups = (category: SettingTreeNode): ISettingGroup[] => {
Expand All @@ -178,12 +180,50 @@ const sortedGroups = (category: SettingTreeNode): ISettingGroup[] => {
}

const searchQuery = ref<string>('')
const filteredSettingIds = ref<string[]>([])
const searchInProgress = ref<boolean>(false)
watch(searchQuery, () => (searchInProgress.value = true))

const searchResults = computed<ISettingGroup[]>(() => {
const groupedSettings: { [key: string]: SettingParams[] } = {}

filteredSettingIds.value.forEach((id) => {
const setting = settingStore.settings[id]
const info = getSettingInfo(setting)
const groupLabel = info.subCategory

if (
activeCategory.value === null ||
activeCategory.value.label === info.category
) {
if (!groupedSettings[groupLabel]) {
groupedSettings[groupLabel] = []
}
groupedSettings[groupLabel].push(setting)
}
})

return Object.entries(groupedSettings).map(([label, settings]) => ({
label,
settings
}))
})

/**
* Settings categories that contains at least one setting in search results.
*/
const searchResultsCategories = computed<Set<string>>(() => {
return new Set(
filteredSettingIds.value.map(
(id) => getSettingInfo(settingStore.settings[id]).category
)
)
})

const handleSearch = (query: string) => {
if (!query) {
searchResults.value = []
filteredSettingIds.value = []
activeCategory.value ??= getDefaultCategory()
return
}

Expand All @@ -203,22 +243,9 @@ const handleSearch = (query: string) => {
)
})

const groupedSettings: { [key: string]: SettingParams[] } = {}
filteredSettings.forEach((setting) => {
const groupLabel = setting.id.split('.')[1]
if (!groupedSettings[groupLabel]) {
groupedSettings[groupLabel] = []
}
groupedSettings[groupLabel].push(setting)
})

searchResults.value = Object.entries(groupedSettings).map(
([label, settings]) => ({
label,
settings
})
)
filteredSettingIds.value = filteredSettings.map((x) => x.id)
searchInProgress.value = false
activeCategory.value = null
}

const inSearch = computed(
Expand All @@ -227,6 +254,13 @@ const inSearch = computed(
const tabValue = computed(() =>
inSearch.value ? 'Search Results' : activeCategory.value?.label
)
// Don't allow null category to be set outside of search.
// In search mode, the active category can be null to show all search results.
watch(activeCategory, (_, oldValue) => {
if (!tabValue.value) {
activeCategory.value = oldValue
}
})
</script>

<style>
Expand Down
9 changes: 9 additions & 0 deletions src/stores/settingStore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ import type { ComfyExtension } from '@/types/comfy'
import { buildTree } from '@/utils/treeUtil'
import { CORE_SETTINGS } from '@/constants/coreSettings'

export const getSettingInfo = (setting: SettingParams) => {
const parts = setting.category || setting.id.split('.')
return {
category: parts[0],
subCategory: parts[1],
name: parts.slice(2).join('.')
}
}

export interface SettingTreeNode extends TreeNode {
data?: SettingParams
}
Expand Down
Loading