Plugin platform awareness?

Imperial_Squid · 2024-07-07T04:33:38.075Z

Just out of curiosity, is there currently any way for a plugin to be aware of whether it's running on mobile vs desktop?

I've been really enjoying the ability to use plugins (being able to quickly make links has made bullet journalling so much easier!) but I'm running into a few struggles where plugins are missing features that aren't needed on desktop but become required on mobile (eg due to the lack of keyboard shortcuts/mouse right clicking/etc)

While I'm not a plugin dev I thought it might be useful for plugins to know what platforms they're on in case they need to do things like create buttons for certain actions etc

Alternatively I can see an argument for not having different behaviour depending on the platform

Wondered what everyone's thoughts on this is?

Cheers

personalizedrefriger · 2024-07-07T04:46:41.604Z

Imperial_Squid:

Just out of curiosity, is there currently any way for a plugin to be aware of whether it's running on mobile vs desktop?

This is how the RevealJS Slides plugin does it:

github.com

personalizedrefrigerator/joplin-plugin-revealjs-slides/blob/ed3409ef62ebc72862c2b6ec95acce545423037c/src/util/isMobile.ts#L6


      
          import joplin from "api";
          
          const isMobile = async () => {
          	try {
          		const version = await joplin.versionInfo() as any;
          		return version?.platform === 'mobile';
          	} catch(error) {
          		console.warn('Error checking whether the device is a mobile device. Assuming desktop.', error);
          		return false;
          	}
          };
          
          export default isMobile;

Notes:

If the plugin targets only recent versions of Joplin, the try { ... } catch(error) { is unnecessary.
The as any cast is present because the updated .versionInfo return type hasn't been generated/published to NPM.

Imperial_Squid · 2024-07-07T05:10:21.537Z

Darn it, classic case of not quite reading the API docs closely enough!

Thanks for the answer