PlatformEx

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:15

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

Example

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

Extends

PlatformType

Properties

canDisplayRibbon

canDisplayRibbon: boolean

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:16

canExportPdf

canExportPdf: boolean

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:17

canPopoutWindow

canPopoutWindow: boolean

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:18

canSplit

canSplit: boolean

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:19

canStackTabs

canStackTabs: boolean

Defined in: src/obsidian/internals/Platform/PlatformEx.d.ts:20

isAndroidApp

isAndroidApp: boolean

Defined in: obsidian.d.ts:3052

We’re running the Android app.

Inherited from

PlatformType.isAndroidApp

isDesktop

isDesktop: boolean

Defined in: obsidian.d.ts:3027

The UI is in desktop mode.

Inherited from

PlatformType.isDesktop

isDesktopApp

isDesktopApp: boolean

Defined in: obsidian.d.ts:3037

We’re running the electron-based desktop app.

Inherited from

PlatformType.isDesktopApp

isIosApp

isIosApp: boolean

Defined in: obsidian.d.ts:3047

We’re running the iOS app.

Inherited from

PlatformType.isIosApp

isLinux

isLinux: boolean

Defined in: obsidian.d.ts:3078

We’re on a Linux device.

Inherited from

PlatformType.isLinux

isMacOS

isMacOS: boolean

Defined in: obsidian.d.ts:3068

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.