feat(machine): operator branding — optional logo-dark.png variant
Sibling-file convention: drop a logo-dark.png alongside logo.png in /var/lib/bitspire/branding/ and the renderer uses it whenever the effective color mode is dark, falling back to logo.png when absent. No branding.json change — the file name itself is the contract. Wiring: - electron/main.ts:loadBranding() reads logo-dark.png and base64-encodes it into logoDarkDataUrl on the IPC payload - composables/useTheme.ts exposes an `isDark` computed that resolves the 'system' colorMode via the prefers-color-scheme media query (and reacts to OS-level dark-mode changes via the existing listener) - composables/useBranding.ts switches logoUrl reactively based on isDark - IdleView already binds to logoUrl — no template change needed Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
f589b1c078
commit
b6169da45d
6 changed files with 57 additions and 14 deletions
|
|
@ -60,16 +60,20 @@ function loadEnvFile() {
|
||||||
|
|
||||||
loadEnvFile()
|
loadEnvFile()
|
||||||
|
|
||||||
// Branding loader — reads /var/lib/bitspire/branding/{logo.png,branding.json}
|
// Branding loader — reads /var/lib/bitspire/branding/{logo.png,
|
||||||
// and surfaces them on get-config. Per issue #47: local-file is the V1
|
// logo-dark.png,branding.json} and surfaces them on get-config. Per
|
||||||
// source; V2 will overlay a higher-priority Nostr-event source from
|
// issue #47: local-file is the V1 source; V2 will overlay a
|
||||||
// satmachineadmin (issue #48). Renderer applies via useBranding().
|
// higher-priority Nostr-event source from satmachineadmin (issue #48).
|
||||||
|
// Renderer applies via useBranding().
|
||||||
type BrandingConfig = {
|
type BrandingConfig = {
|
||||||
title: string | null
|
title: string | null
|
||||||
theme: string | null
|
theme: string | null
|
||||||
customColors?: Record<string, string>
|
customColors?: Record<string, string>
|
||||||
customColorsDark?: Record<string, string>
|
customColorsDark?: Record<string, string>
|
||||||
logoDataUrl: string | null
|
logoDataUrl: string | null
|
||||||
|
/** Optional dark-mode logo variant. Renderer falls back to logoDataUrl
|
||||||
|
* when null. */
|
||||||
|
logoDarkDataUrl: string | null
|
||||||
}
|
}
|
||||||
|
|
||||||
const VALID_THEMES = new Set([
|
const VALID_THEMES = new Set([
|
||||||
|
|
@ -94,6 +98,7 @@ function loadBranding(): BrandingConfig | null {
|
||||||
let customColors: Record<string, string> | undefined
|
let customColors: Record<string, string> | undefined
|
||||||
let customColorsDark: Record<string, string> | undefined
|
let customColorsDark: Record<string, string> | undefined
|
||||||
let logoDataUrl: string | null = null
|
let logoDataUrl: string | null = null
|
||||||
|
let logoDarkDataUrl: string | null = null
|
||||||
|
|
||||||
const jsonPath = path.join(brandingDir, 'branding.json')
|
const jsonPath = path.join(brandingDir, 'branding.json')
|
||||||
if (fs.existsSync(jsonPath)) {
|
if (fs.existsSync(jsonPath)) {
|
||||||
|
|
@ -131,16 +136,27 @@ function loadBranding(): BrandingConfig | null {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const logoDarkPath = path.join(brandingDir, 'logo-dark.png')
|
||||||
|
if (fs.existsSync(logoDarkPath)) {
|
||||||
|
try {
|
||||||
|
const buf = fs.readFileSync(logoDarkPath)
|
||||||
|
logoDarkDataUrl = `data:image/png;base64,${buf.toString('base64')}`
|
||||||
|
} catch (e) {
|
||||||
|
console.warn('[Electron] Failed to read logo-dark.png:', e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (
|
if (
|
||||||
title === null &&
|
title === null &&
|
||||||
theme === null &&
|
theme === null &&
|
||||||
!customColors &&
|
!customColors &&
|
||||||
!customColorsDark &&
|
!customColorsDark &&
|
||||||
logoDataUrl === null
|
logoDataUrl === null &&
|
||||||
|
logoDarkDataUrl === null
|
||||||
) {
|
) {
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
return { title, theme, customColors, customColorsDark, logoDataUrl }
|
return { title, theme, customColors, customColorsDark, logoDataUrl, logoDarkDataUrl }
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determine if we're in development
|
// Determine if we're in development
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,7 @@ export interface BrandingConfig {
|
||||||
customColors?: Record<string, string>
|
customColors?: Record<string, string>
|
||||||
customColorsDark?: Record<string, string>
|
customColorsDark?: Record<string, string>
|
||||||
logoDataUrl: string | null
|
logoDataUrl: string | null
|
||||||
|
logoDarkDataUrl: string | null
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ref } from 'vue'
|
import { ref, computed } from 'vue'
|
||||||
import type { BrandingConfig } from '@/types/electron'
|
import type { BrandingConfig } from '@/types/electron'
|
||||||
import { applyBrandingTheme } from './useTheme'
|
import { applyBrandingTheme, useTheme } from './useTheme'
|
||||||
|
|
||||||
// Reactive branding state — sourced from a BrandingSource (V1: local file
|
// Reactive branding state — sourced from a BrandingSource (V1: local file
|
||||||
// via Electron IPC; V2 per issue #48: replaceable Nostr event from
|
// via Electron IPC; V2 per issue #48: replaceable Nostr event from
|
||||||
|
|
@ -8,9 +8,18 @@ import { applyBrandingTheme } from './useTheme'
|
||||||
const DEFAULT_LOGO = '/logo.png'
|
const DEFAULT_LOGO = '/logo.png'
|
||||||
const DEFAULT_TITLE = 'Bitcoinmat'
|
const DEFAULT_TITLE = 'Bitcoinmat'
|
||||||
|
|
||||||
const logoUrl = ref<string>(DEFAULT_LOGO)
|
const logoLightUrl = ref<string>(DEFAULT_LOGO)
|
||||||
|
const logoDarkUrl = ref<string | null>(null)
|
||||||
const title = ref<string>(DEFAULT_TITLE)
|
const title = ref<string>(DEFAULT_TITLE)
|
||||||
|
|
||||||
|
const { isDark } = useTheme()
|
||||||
|
|
||||||
|
/** Effective logo: dark variant when dark mode is active AND operator
|
||||||
|
* supplied one, otherwise the regular logo. */
|
||||||
|
const logoUrl = computed(() =>
|
||||||
|
isDark.value && logoDarkUrl.value ? logoDarkUrl.value : logoLightUrl.value
|
||||||
|
)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Apply a branding payload to the live UI. Pass null to revert to defaults.
|
* Apply a branding payload to the live UI. Pass null to revert to defaults.
|
||||||
* Single mutation point — V2's Nostr-event source calls the same setter when
|
* Single mutation point — V2's Nostr-event source calls the same setter when
|
||||||
|
|
@ -18,12 +27,14 @@ const title = ref<string>(DEFAULT_TITLE)
|
||||||
*/
|
*/
|
||||||
export function setBranding(b: BrandingConfig | null) {
|
export function setBranding(b: BrandingConfig | null) {
|
||||||
if (!b) {
|
if (!b) {
|
||||||
logoUrl.value = DEFAULT_LOGO
|
logoLightUrl.value = DEFAULT_LOGO
|
||||||
|
logoDarkUrl.value = null
|
||||||
title.value = DEFAULT_TITLE
|
title.value = DEFAULT_TITLE
|
||||||
applyBrandingTheme(null)
|
applyBrandingTheme(null)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
logoUrl.value = b.logoDataUrl || DEFAULT_LOGO
|
logoLightUrl.value = b.logoDataUrl || DEFAULT_LOGO
|
||||||
|
logoDarkUrl.value = b.logoDarkDataUrl || null
|
||||||
title.value = b.title || DEFAULT_TITLE
|
title.value = b.title || DEFAULT_TITLE
|
||||||
applyBrandingTheme(
|
applyBrandingTheme(
|
||||||
b.theme as Parameters<typeof applyBrandingTheme>[0],
|
b.theme as Parameters<typeof applyBrandingTheme>[0],
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
import { ref, watch } from 'vue'
|
import { ref, computed, watch } from 'vue'
|
||||||
|
|
||||||
export type ThemeId = 'gruvbox' | 'catppuccin' | 'cyberpunk' | 'dracula' | 'nord' | 'tokyo-night'
|
export type ThemeId = 'gruvbox' | 'catppuccin' | 'cyberpunk' | 'dracula' | 'nord' | 'tokyo-night'
|
||||||
export type ColorMode = 'light' | 'dark' | 'system'
|
export type ColorMode = 'light' | 'dark' | 'system'
|
||||||
|
|
@ -112,12 +112,22 @@ function applyColorMode(mode: ColorMode) {
|
||||||
|
|
||||||
// Listen for system preference changes when mode is 'system'
|
// Listen for system preference changes when mode is 'system'
|
||||||
const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
|
const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
|
||||||
mediaQuery.addEventListener('change', () => {
|
const prefersDark = ref(mediaQuery.matches)
|
||||||
|
mediaQuery.addEventListener('change', (e) => {
|
||||||
|
prefersDark.value = e.matches
|
||||||
if (colorMode.value === 'system') {
|
if (colorMode.value === 'system') {
|
||||||
applyColorMode('system')
|
applyColorMode('system')
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
/** True when the effective color mode is dark (resolves 'system' via media query).
|
||||||
|
* Consumed by useBranding to pick logo-dark.png over logo.png. */
|
||||||
|
const isDark = computed(() => {
|
||||||
|
if (colorMode.value === 'dark') return true
|
||||||
|
if (colorMode.value === 'light') return false
|
||||||
|
return prefersDark.value
|
||||||
|
})
|
||||||
|
|
||||||
// Apply on load
|
// Apply on load
|
||||||
applyTheme(current.value)
|
applyTheme(current.value)
|
||||||
applyColorMode(colorMode.value)
|
applyColorMode(colorMode.value)
|
||||||
|
|
@ -146,5 +156,6 @@ export function useTheme() {
|
||||||
current,
|
current,
|
||||||
themes,
|
themes,
|
||||||
colorMode,
|
colorMode,
|
||||||
|
isDark,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
3
apps/machine/src/types/electron.d.ts
vendored
3
apps/machine/src/types/electron.d.ts
vendored
|
|
@ -38,6 +38,9 @@ export interface BrandingConfig {
|
||||||
customColorsDark?: Record<string, string>
|
customColorsDark?: Record<string, string>
|
||||||
/** Base64 data URL of operator-supplied logo.png. Null when no file present. */
|
/** Base64 data URL of operator-supplied logo.png. Null when no file present. */
|
||||||
logoDataUrl: string | null
|
logoDataUrl: string | null
|
||||||
|
/** Base64 data URL of operator-supplied logo-dark.png; renderer uses this
|
||||||
|
* when dark mode is active, falling back to logoDataUrl when null. */
|
||||||
|
logoDarkDataUrl: string | null
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface AtmSecrets {
|
export interface AtmSecrets {
|
||||||
|
|
|
||||||
|
|
@ -10,9 +10,10 @@
|
||||||
#
|
#
|
||||||
# Expected files in <branding-dir>:
|
# Expected files in <branding-dir>:
|
||||||
# logo.png — operator logo (any reasonable size; rendered ~12vh)
|
# logo.png — operator logo (any reasonable size; rendered ~12vh)
|
||||||
|
# logo-dark.png — optional dark-mode variant; falls back to logo.png if absent
|
||||||
# branding.json — { title, theme, custom_colors{...}, custom_colors.dark{...} }
|
# branding.json — { title, theme, custom_colors{...}, custom_colors.dark{...} }
|
||||||
#
|
#
|
||||||
# Either file is optional; the on-disk schema in /var/lib/bitspire/branding/
|
# Any file is optional; the on-disk schema in /var/lib/bitspire/branding/
|
||||||
# matches whatever <branding-dir> contains (rsync --delete).
|
# matches whatever <branding-dir> contains (rsync --delete).
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue