Skip to content

docs: Weekly Documentation Update #6369

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −9
Draft

docs: Weekly Documentation Update #6369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ When referencing Comfy-Org repos:

### Settings Usage
```typescript
import { useSettingStore } from '@/platform/settings/settingStore'

const settingStore = useSettingStore()
const value = settingStore.get('Comfy.SomeSetting') // Get setting
await settingStore.set('Comfy.SomeSetting', newValue) // Update setting
Expand Down
18 changes: 9 additions & 9 deletions docs/SETTINGS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
ComfyUI frontend uses a comprehensive settings system for user preferences with support for dynamic defaults, version-based rollouts, and environment-aware configuration.

### Settings Architecture
- Settings are defined as `SettingParams` in `src/constants/coreSettings.ts`
- Settings are defined as `SettingParams` in `src/platform/settings/constants/coreSettings.ts`
- Registered at app startup, loaded/saved via `useSettingStore` (Pinia)
- Persisted per user via backend `/settings` endpoint
- If a value hasn't been set by the user, the store returns the computed default

```typescript
// From src/stores/settingStore.ts:105-122
// From src/platform/settings/settingStore.ts
function getDefaultValue<K extends keyof Settings>(
key: K
): Settings[K] | undefined {
Expand Down Expand Up @@ -48,7 +48,7 @@ await newUserService().initializeIfNewUser(settingStore)
You can compute defaults dynamically using function defaults that access runtime context:

```typescript
// From src/constants/coreSettings.ts:94-101
// From src/platform/settings/constants/coreSettings.ts
{
id: 'Comfy.Sidebar.Size',
// Default to small if the window is less than 1536px(2xl) wide
Expand All @@ -57,7 +57,7 @@ You can compute defaults dynamically using function defaults that access runtime
```

```typescript
// From src/constants/coreSettings.ts:306
// From src/platform/settings/constants/coreSettings.ts
{
id: 'Comfy.Locale',
defaultValue: () => navigator.language.split('-')[0] || 'en'
Expand All @@ -68,7 +68,7 @@ You can compute defaults dynamically using function defaults that access runtime
You can vary defaults by installed frontend version using `defaultsByInstallVersion`:

```typescript
// From src/stores/settingStore.ts:129-150
// From src/platform/settings/settingStore.ts
function getVersionedDefaultValue<K extends keyof Settings, TValue = Settings[K]>(
key: K,
param: SettingParams<TValue> | undefined
Expand Down Expand Up @@ -98,7 +98,7 @@ function getVersionedDefaultValue<K extends keyof Settings, TValue = Settings[K]
Example versioned defaults from codebase:

```typescript
// From src/constants/coreSettings.ts:38-40
// From src/platform/settings/constants/coreSettings.ts
{
id: 'Comfy.Graph.LinkReleaseAction',
defaultValue: LinkReleaseTriggerAction.CONTEXT_MENU,
Expand Down Expand Up @@ -217,7 +217,7 @@ await settingStore.set(
Values are stored per user via the backend. The store writes through API and falls back to defaults when not set:

```typescript
// From src/stores/settingStore.ts:73-75
// From src/platform/settings/settingStore.ts
onChange(settingsById.value[key], newValue, oldValue)
settingValues.value[key] = newValue
await api.storeSetting(key, newValue)
Expand All @@ -242,7 +242,7 @@ await settingStore.set('Comfy.SomeSetting', newValue)
Settings support migration from deprecated values:

```typescript
// From src/stores/settingStore.ts:68-69, 172-175
// From src/platform/settings/settingStore.ts
const newValue = tryMigrateDeprecatedValue(
settingsById.value[key],
clonedValue
Expand All @@ -262,7 +262,7 @@ if (settingValues.value[setting.id] !== undefined) {
Settings can define onChange callbacks that receive the setting definition, new value, and old value:

```typescript
// From src/stores/settingStore.ts:73, 177
// From src/platform/settings/settingStore.ts
onChange(settingsById.value[key], newValue, oldValue) // During set()
onChange(setting, get(setting.id), undefined) // During addSetting()
```
Expand Down