PlatformEx

Unofficial

Both Official Unofficial

Both Own Inherited

Due to limitations of TypeScript, we cannot extend the obsidian#Platform constant directly.

Import:

import type { PlatformEx } from '@obsidian-typings/obsidian-public-latest';

Example:

import { Platform } from 'obsidian';
import type { PlatformEx } from 'obsidian-typings';
const platformEx = Platform as PlatformEx;
console.log(platformEx.canDisplayRibbon);

Signature:

export interface PlatformEx

Properties

	Property	Type	Description
	build	string	The version of the installer that shipped this app. It advances independently of PlatformEx.version and determines which Electron version the app runs on.
	canDisplayRibbon	boolean	Whether the platform supports displaying the sidebar ribbon.
	canExportPdf	boolean	Whether the platform supports exporting to PDF.
	canOpenExternalFiles	boolean	Whether the platform supports opening files that live outside the vault. It gates the app:open-file command, dropping files from the OS onto the tab bar, and the external-file fallback in the vault path lookups.
	canPinSidebar	boolean	Whether the platform supports pinning the sidebar.
	canPopoutWindow	boolean	Whether the platform supports popping out windows.
	canSplit	boolean	Whether the platform supports splitting panes.
	canStackTabs	boolean	Whether the platform supports stacking tabs.
	deviceName	string	The name of the device. On desktop this is the host name of the machine.
	hasPhysicalKeyboard	boolean	Whether a hardware keyboard is attached. Always true in the desktop app.
	isAndroidApp	boolean	We're running the Android app.
	isDesktop	boolean	The UI is in desktop mode.
	isDesktopApp	boolean	We're running the Electron-based desktop app.
	isIosApp	boolean	We're running the iOS app.
	isLinux	boolean	We're on a Linux device.
	isMacOS	boolean	We're on a macOS device, or a device that pretends to be one (like iPhones and iPads). Typically used to detect whether to use command-based hotkeys vs ctrl-based hotkeys.
	isMobile	boolean	The UI is in mobile mode.
	isMobileApp	boolean	We're running the Capacitor mobile app.
	isPhone	boolean	We're in a mobile app that has very limited screen space.
	isSafari	boolean	We're running in Safari. Typically used to provide workarounds for Safari bugs.
	isTablet	boolean	We're in a mobile app that has sufficiently large screen space.
	isWin	boolean	We're on a Windows device.
	manufacturer	string	The manufacturer of the device. Empty on desktop.
	mobileDeviceHeight	number	Height of the mobile device screen in pixels.
	mobileKeyboardHeight	number	Height of the software keyboard in pixels on mobile.
	mobileSoftKeyboardVisible	boolean	Whether the software keyboard is currently visible on mobile.
	model	string	The model of the device. Empty on desktop.
	osName	string	The name of the operating system. On desktop this is the descriptive version string, such as Windows 11 Pro.
	osVersion	string	The version of the operating system. On desktop this is the kernel release, such as 10.0.26200.
	resourcePathPrefix	string	The path prefix for resolving local files on this platform. This returns: - file:/// on mobile. - app://random-id/ on desktop (Replaces the old format of app://local/).
	supportsIndexedDb	boolean	Whether IndexedDB is available on this platform. Features that need it are disabled when it is not.
	version	string	The version of the Obsidian app.

---

Links to this page:

• getPlatformEx
• Platform