Merge remote-tracking branch 'origin/main' into feat/backend
Sync source to CNB / Sync Git ref (push) Skipped
Sync source to CNB / Sync Git ref (push) Skipped
This commit is contained in:
AxTps committed
commit
fce6c60759
26 files changed
+2701
-246
No files matched your search
@@ -0,0 +1,14 @@
|
||||
const NAV_SHORTCUT_STORAGE_PREFIX = 'starlight-shortcut-nav-'
|
||||
|
||||
/**
|
||||
* Whether a navigation shortcut is enabled. Shortcuts are off by default;
|
||||
* each one is turned on individually from the Shortcut settings page.
|
||||
*/
|
||||
export function getNavShortcutEnabled(id: string): boolean {
|
||||
const value = localStorage.getItem(NAV_SHORTCUT_STORAGE_PREFIX + id)
|
||||
return value === 'true'
|
||||
}
|
||||
|
||||
export function setNavShortcutEnabled(id: string, enabled: boolean) {
|
||||
localStorage.setItem(NAV_SHORTCUT_STORAGE_PREFIX + id, String(enabled))
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
const SHOW_SCROLL_TOP_STORAGE_KEY = 'starlight-show-scroll-top'
|
||||
const QUICK_SCROLL_ENABLED_STORAGE_KEY = 'starlight-quick-scroll-enabled'
|
||||
|
||||
export function getShowScrollTop(): boolean {
|
||||
const value = localStorage.getItem(SHOW_SCROLL_TOP_STORAGE_KEY)
|
||||
return value !== 'false'
|
||||
}
|
||||
|
||||
export function setShowScrollTop(show: boolean) {
|
||||
localStorage.setItem(SHOW_SCROLL_TOP_STORAGE_KEY, String(show))
|
||||
}
|
||||
|
||||
export function getQuickScrollEnabled(): boolean {
|
||||
const value = localStorage.getItem(QUICK_SCROLL_ENABLED_STORAGE_KEY)
|
||||
return value === 'true'
|
||||
}
|
||||
|
||||
export function setQuickScrollEnabled(enabled: boolean) {
|
||||
localStorage.setItem(QUICK_SCROLL_ENABLED_STORAGE_KEY, String(enabled))
|
||||
}
|
||||
@@ -0,0 +1,309 @@
|
||||
import { defineMessages, type KeyBinding, type MessageDescriptor } from '@modrinth/ui'
|
||||
import type { RouteLocationNormalizedLoaded } from 'vue-router'
|
||||
|
||||
import { getLastBrowseContentProjectType, isBrowseContentProjectType } from '@/helpers/settings'
|
||||
|
||||
/** Which half of the settings page an action belongs to. */
|
||||
export type ShortcutGroupId = 'scroll' | 'nav'
|
||||
|
||||
/** Theme store fields that switch an action on. */
|
||||
export type ShortcutEnabledField =
|
||||
| 'quickScrollEnabled'
|
||||
| 'shortcutNavHome'
|
||||
| 'shortcutNavWorlds'
|
||||
| 'shortcutNavDiscover'
|
||||
| 'shortcutNavSkins'
|
||||
| 'shortcutNavMultiplayer'
|
||||
| 'shortcutNavLibrary'
|
||||
| 'shortcutNavLab'
|
||||
| 'shortcutNavDownloads'
|
||||
| 'shortcutNavCreate'
|
||||
| 'shortcutNavSettings'
|
||||
|
||||
export interface ShortcutContext {
|
||||
worldsTabEnabled: boolean
|
||||
offline: boolean
|
||||
}
|
||||
|
||||
export interface ShortcutAction {
|
||||
/** Stable id, used for the binding, the enable flag and the settings row. */
|
||||
id: string
|
||||
group: ShortcutGroupId
|
||||
enabledField: ShortcutEnabledField
|
||||
defaultBinding: KeyBinding
|
||||
label: MessageDescriptor
|
||||
description: MessageDescriptor
|
||||
/** Navigation actions know where they lead. */
|
||||
target?: (route: RouteLocationNormalizedLoaded) => string
|
||||
/** Navigation actions that are not reachable right now. */
|
||||
unavailable?: (context: ShortcutContext) => boolean
|
||||
/** Scrolling actions move the page's own scroller. */
|
||||
applyScroll?: (scroller: HTMLElement) => void
|
||||
}
|
||||
|
||||
/**
|
||||
* Declared here rather than assembled from the action ids, so the extractor can
|
||||
* see them; an id built at runtime is one a translation pass would drop.
|
||||
*/
|
||||
const messages = defineMessages({
|
||||
scrollTop: {
|
||||
id: 'app.shortcut-settings.home-action',
|
||||
defaultMessage: 'Scroll to the top',
|
||||
},
|
||||
scrollTopDescription: {
|
||||
id: 'app.shortcut-settings.home-action-description',
|
||||
defaultMessage: 'Moves the page you are reading to the top.',
|
||||
},
|
||||
scrollBottom: {
|
||||
id: 'app.shortcut-settings.end-action',
|
||||
defaultMessage: 'Scroll to the bottom',
|
||||
},
|
||||
scrollBottomDescription: {
|
||||
id: 'app.shortcut-settings.end-action-description',
|
||||
defaultMessage: 'Moves the page you are reading to the bottom.',
|
||||
},
|
||||
scrollUp: {
|
||||
id: 'app.shortcut-settings.page-up-action',
|
||||
defaultMessage: 'Scroll up one screen',
|
||||
},
|
||||
scrollUpDescription: {
|
||||
id: 'app.shortcut-settings.page-up-action-description',
|
||||
defaultMessage: 'Moves the page you are reading up by one screen.',
|
||||
},
|
||||
scrollDown: {
|
||||
id: 'app.shortcut-settings.page-down-action',
|
||||
defaultMessage: 'Scroll down one screen',
|
||||
},
|
||||
scrollDownDescription: {
|
||||
id: 'app.shortcut-settings.page-down-action-description',
|
||||
defaultMessage: 'Moves the page you are reading down by one screen.',
|
||||
},
|
||||
navHome: { id: 'app.shortcut-settings.nav-home', defaultMessage: 'Home' },
|
||||
navHomeDescription: {
|
||||
id: 'app.shortcut-settings.nav-home-description',
|
||||
defaultMessage: 'Jump to the Home page.',
|
||||
},
|
||||
navWorlds: { id: 'app.shortcut-settings.nav-worlds', defaultMessage: 'Worlds' },
|
||||
navWorldsDescription: {
|
||||
id: 'app.shortcut-settings.nav-worlds-description',
|
||||
defaultMessage: 'Jump to your worlds.',
|
||||
},
|
||||
navDiscover: {
|
||||
id: 'app.shortcut-settings.nav-discover',
|
||||
defaultMessage: 'Discover content',
|
||||
},
|
||||
navDiscoverDescription: {
|
||||
id: 'app.shortcut-settings.nav-discover-description',
|
||||
defaultMessage: 'Jump to browsing content.',
|
||||
},
|
||||
navSkins: { id: 'app.shortcut-settings.nav-skins', defaultMessage: 'Skin selector' },
|
||||
navSkinsDescription: {
|
||||
id: 'app.shortcut-settings.nav-skins-description',
|
||||
defaultMessage: 'Jump to the skin selector.',
|
||||
},
|
||||
navMultiplayer: { id: 'app.shortcut-settings.nav-multiplayer', defaultMessage: 'Multiplayer' },
|
||||
navMultiplayerDescription: {
|
||||
id: 'app.shortcut-settings.nav-multiplayer-description',
|
||||
defaultMessage: 'Jump to multiplayer.',
|
||||
},
|
||||
navLibrary: { id: 'app.shortcut-settings.nav-library', defaultMessage: 'Library' },
|
||||
navLibraryDescription: {
|
||||
id: 'app.shortcut-settings.nav-library-description',
|
||||
defaultMessage: 'Jump to your library.',
|
||||
},
|
||||
navLab: { id: 'app.shortcut-settings.nav-lab', defaultMessage: 'Lab' },
|
||||
navLabDescription: {
|
||||
id: 'app.shortcut-settings.nav-lab-description',
|
||||
defaultMessage: 'Jump to the Lab.',
|
||||
},
|
||||
navDownloads: { id: 'app.shortcut-settings.nav-downloads', defaultMessage: 'Downloads' },
|
||||
navDownloadsDescription: {
|
||||
id: 'app.shortcut-settings.nav-downloads-description',
|
||||
defaultMessage: 'Jump to downloads.',
|
||||
},
|
||||
navCreate: { id: 'app.shortcut-settings.nav-create', defaultMessage: 'Create new instance' },
|
||||
navCreateDescription: {
|
||||
id: 'app.shortcut-settings.nav-create-description',
|
||||
defaultMessage: 'Jump to creating a new instance.',
|
||||
},
|
||||
navSettings: { id: 'app.shortcut-settings.nav-settings', defaultMessage: 'Settings' },
|
||||
navSettingsDescription: {
|
||||
id: 'app.shortcut-settings.nav-settings-description',
|
||||
defaultMessage: 'Jump to the settings.',
|
||||
},
|
||||
})
|
||||
|
||||
function keyboard(code: string, mod = false, alt = false, shift = false): KeyBinding {
|
||||
return { device: 'keyboard', code, mod, alt, shift }
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the Discover content target from the current route, so the nav
|
||||
* button and the keyboard shortcut share one source of truth.
|
||||
*/
|
||||
export function discoverContentTarget(route: RouteLocationNormalizedLoaded): string {
|
||||
const projectType = route.params.projectType
|
||||
if (
|
||||
!route.query.i &&
|
||||
!route.query.sid &&
|
||||
!route.query.wid &&
|
||||
typeof projectType === 'string' &&
|
||||
isBrowseContentProjectType(projectType)
|
||||
) {
|
||||
return `/browse/${projectType}`
|
||||
}
|
||||
|
||||
return `/browse/${getLastBrowseContentProjectType()}`
|
||||
}
|
||||
|
||||
/**
|
||||
* Every shortcut the launcher answers to. The binding here is the one a fresh
|
||||
* install uses; a recorded binding is stored separately and wins over it.
|
||||
*/
|
||||
export const SHORTCUT_ACTIONS: ShortcutAction[] = [
|
||||
{
|
||||
id: 'shortcutScrollTop',
|
||||
group: 'scroll',
|
||||
enabledField: 'quickScrollEnabled',
|
||||
defaultBinding: keyboard('Home'),
|
||||
label: messages.scrollTop,
|
||||
description: messages.scrollTopDescription,
|
||||
applyScroll: (scroller) => scroller.scrollTo({ top: 0, behavior: 'smooth' }),
|
||||
},
|
||||
{
|
||||
id: 'shortcutScrollBottom',
|
||||
group: 'scroll',
|
||||
enabledField: 'quickScrollEnabled',
|
||||
defaultBinding: keyboard('End'),
|
||||
label: messages.scrollBottom,
|
||||
description: messages.scrollBottomDescription,
|
||||
applyScroll: (scroller) =>
|
||||
scroller.scrollTo({ top: scroller.scrollHeight, behavior: 'smooth' }),
|
||||
},
|
||||
{
|
||||
id: 'shortcutScrollUp',
|
||||
group: 'scroll',
|
||||
enabledField: 'quickScrollEnabled',
|
||||
defaultBinding: keyboard('PageUp'),
|
||||
label: messages.scrollUp,
|
||||
description: messages.scrollUpDescription,
|
||||
applyScroll: (scroller) => {
|
||||
// Immediate scrolling keeps rapid key repeats responsive.
|
||||
scroller.scrollTop = Math.max(0, scroller.scrollTop - scroller.clientHeight * 0.9)
|
||||
},
|
||||
},
|
||||
{
|
||||
id: 'shortcutScrollDown',
|
||||
group: 'scroll',
|
||||
enabledField: 'quickScrollEnabled',
|
||||
defaultBinding: keyboard('PageDown'),
|
||||
label: messages.scrollDown,
|
||||
description: messages.scrollDownDescription,
|
||||
applyScroll: (scroller) => {
|
||||
scroller.scrollTop = Math.min(
|
||||
scroller.scrollHeight,
|
||||
scroller.scrollTop + scroller.clientHeight * 0.9,
|
||||
)
|
||||
},
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavHome',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavHome',
|
||||
defaultBinding: keyboard('Digit1', true),
|
||||
label: messages.navHome,
|
||||
description: messages.navHomeDescription,
|
||||
target: () => '/',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavWorlds',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavWorlds',
|
||||
defaultBinding: keyboard('Digit2', true),
|
||||
label: messages.navWorlds,
|
||||
description: messages.navWorldsDescription,
|
||||
target: () => '/worlds',
|
||||
unavailable: (context) => !context.worldsTabEnabled,
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavDiscover',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavDiscover',
|
||||
defaultBinding: keyboard('Digit3', true),
|
||||
label: messages.navDiscover,
|
||||
description: messages.navDiscoverDescription,
|
||||
target: (route) => discoverContentTarget(route),
|
||||
unavailable: (context) => context.offline,
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavSkins',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavSkins',
|
||||
defaultBinding: keyboard('Digit4', true),
|
||||
label: messages.navSkins,
|
||||
description: messages.navSkinsDescription,
|
||||
target: () => '/skins',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavMultiplayer',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavMultiplayer',
|
||||
defaultBinding: keyboard('Digit5', true),
|
||||
label: messages.navMultiplayer,
|
||||
description: messages.navMultiplayerDescription,
|
||||
target: () => '/multiplayer',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavLibrary',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavLibrary',
|
||||
defaultBinding: keyboard('Digit6', true),
|
||||
label: messages.navLibrary,
|
||||
description: messages.navLibraryDescription,
|
||||
target: () => '/library',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavLab',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavLab',
|
||||
defaultBinding: keyboard('Digit7', true),
|
||||
label: messages.navLab,
|
||||
description: messages.navLabDescription,
|
||||
target: () => '/lab',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavDownloads',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavDownloads',
|
||||
defaultBinding: keyboard('Digit8', true),
|
||||
label: messages.navDownloads,
|
||||
description: messages.navDownloadsDescription,
|
||||
target: () => '/downloads',
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavCreate',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavCreate',
|
||||
defaultBinding: keyboard('Digit9', true),
|
||||
label: messages.navCreate,
|
||||
description: messages.navCreateDescription,
|
||||
target: () => '/create',
|
||||
unavailable: (context) => context.offline,
|
||||
},
|
||||
{
|
||||
id: 'shortcutNavSettings',
|
||||
group: 'nav',
|
||||
enabledField: 'shortcutNavSettings',
|
||||
defaultBinding: keyboard('Comma', true),
|
||||
label: messages.navSettings,
|
||||
description: messages.navSettingsDescription,
|
||||
target: () => '/settings',
|
||||
},
|
||||
]
|
||||
|
||||
export const SCROLL_ACTIONS = SHORTCUT_ACTIONS.filter((action) => action.group === 'scroll')
|
||||
export const NAV_ACTIONS = SHORTCUT_ACTIONS.filter((action) => action.group === 'nav')
|
||||
|
||||
export function shortcutAction(id: string): ShortcutAction | undefined {
|
||||
return SHORTCUT_ACTIONS.find((action) => action.id === id)
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
import type { BindingConflict, KeyBinding } from '@modrinth/ui'
|
||||
|
||||
import { SHORTCUT_ACTIONS, shortcutAction } from '@/helpers/shortcut-actions'
|
||||
|
||||
const BINDING_STORAGE_PREFIX = 'starlight-shortcut-binding-'
|
||||
|
||||
/**
|
||||
* Combinations the shell or the operating system answers to before the launcher
|
||||
* sees them. Saved shortcuts may not take these over.
|
||||
*/
|
||||
export const RESERVED_BINDINGS: BindingConflict[] = [
|
||||
{
|
||||
id: 'system-find',
|
||||
label: 'Find in page (Ctrl/Cmd + F)',
|
||||
binding: keyboard('KeyF', true),
|
||||
reserved: true,
|
||||
},
|
||||
{
|
||||
id: 'system-devtools',
|
||||
label: 'Developer tools (F12)',
|
||||
binding: keyboard('F12'),
|
||||
reserved: true,
|
||||
},
|
||||
{
|
||||
id: 'system-close',
|
||||
label: 'Close window (Ctrl/Cmd + W)',
|
||||
binding: keyboard('KeyW', true),
|
||||
reserved: true,
|
||||
},
|
||||
{
|
||||
id: 'system-quit',
|
||||
label: 'Quit (Ctrl/Cmd + Q)',
|
||||
binding: keyboard('KeyQ', true),
|
||||
reserved: true,
|
||||
},
|
||||
{
|
||||
id: 'system-reload',
|
||||
label: 'Reload (Ctrl/Cmd + R)',
|
||||
binding: keyboard('KeyR', true),
|
||||
reserved: true,
|
||||
},
|
||||
{ id: 'system-refresh', label: 'Refresh (F5)', binding: keyboard('F5'), reserved: true },
|
||||
{
|
||||
id: 'system-exit',
|
||||
label: 'Close window (Alt + F4)',
|
||||
binding: keyboard('F4', false, true),
|
||||
reserved: true,
|
||||
},
|
||||
]
|
||||
|
||||
function keyboard(code: string, mod = false, alt = false, shift = false): KeyBinding {
|
||||
return { device: 'keyboard', code, mod, alt, shift }
|
||||
}
|
||||
|
||||
function isKeyBinding(value: unknown): value is KeyBinding {
|
||||
if (!value || typeof value !== 'object') return false
|
||||
const candidate = value as Partial<KeyBinding>
|
||||
return (
|
||||
(candidate.device === 'keyboard' || candidate.device === 'mouse') &&
|
||||
typeof candidate.code === 'string' &&
|
||||
candidate.code.length > 0 &&
|
||||
typeof candidate.mod === 'boolean' &&
|
||||
typeof candidate.shift === 'boolean' &&
|
||||
typeof candidate.alt === 'boolean'
|
||||
)
|
||||
}
|
||||
|
||||
/** The combination recorded for an action, if it has one. */
|
||||
export function readStoredBinding(id: string): KeyBinding | null {
|
||||
const raw = localStorage.getItem(BINDING_STORAGE_PREFIX + id)
|
||||
if (!raw) return null
|
||||
|
||||
try {
|
||||
const parsed = JSON.parse(raw)
|
||||
return isKeyBinding(parsed) ? parsed : null
|
||||
} catch {
|
||||
// A value that cannot be read is treated as unset, so the action keeps
|
||||
// working with its default rather than becoming unreachable.
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
export function storeBinding(id: string, binding: KeyBinding) {
|
||||
localStorage.setItem(BINDING_STORAGE_PREFIX + id, JSON.stringify(binding))
|
||||
}
|
||||
|
||||
/** Drops the recorded combination, putting the action back on its default. */
|
||||
export function clearStoredBinding(id: string) {
|
||||
if (readStoredBinding(id)) localStorage.removeItem(BINDING_STORAGE_PREFIX + id)
|
||||
}
|
||||
|
||||
/** The combination an action answers to now: the recorded one, or its default. */
|
||||
export function resolveBinding(id: string): KeyBinding | null {
|
||||
const action = shortcutAction(id)
|
||||
if (!action) return null
|
||||
return readStoredBinding(id) ?? action.defaultBinding
|
||||
}
|
||||
|
||||
export function resolveAllBindings(): Record<string, KeyBinding> {
|
||||
const bindings: Record<string, KeyBinding> = {}
|
||||
for (const action of SHORTCUT_ACTIONS) {
|
||||
bindings[action.id] = resolveBinding(action.id) ?? action.defaultBinding
|
||||
}
|
||||
return bindings
|
||||
}
|
||||
|
||||
/**
|
||||
* Everything a new combination would collide with: the other actions, plus the
|
||||
* combinations the shell owns. `label` is what the dialog names in the error.
|
||||
*/
|
||||
export function buildConflicts(exceptId: string, label: (id: string) => string): BindingConflict[] {
|
||||
const conflicts = SHORTCUT_ACTIONS.filter((action) => action.id !== exceptId).flatMap(
|
||||
(action) => {
|
||||
const binding = resolveBinding(action.id)
|
||||
return binding ? [{ id: action.id, label: label(action.id), binding }] : []
|
||||
},
|
||||
)
|
||||
|
||||
return [...conflicts, ...RESERVED_BINDINGS]
|
||||
}
|
||||
Reference in new issue
Block a user