Documentation
Learn how Polypane improves your workflow
Detecting Polypane
There are two options to detect if your site is running in Polypane. You can use this information to display additional debug information, or serve up various instances of your design (for example, dark and light themes) and test those side by side.
Option 1: user agent
The Polypane user agent is derived from the Chrome user agent and looks like this (With slight variations for Mac, Windows and Linux):
Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Polypane/4.0.0 Chrome/87.0.4280.40 Safari/537.36
The user agent will tell you which version of Polypane and Chromium is being used.
If you use emulation then the user agent might be overwritten. For that we have another option:
Option 2: __polypane object
When running in Polypane, the window
object is extended with a __polypane
key. This is an object that gives you information
on the pane your page is running in. It has these properties:
width
: The width of the pane in pixelsheight
: The height of the pane in pixelsindex
: The (zero-based) index of the paneltitle
: The title of the panehidden
: Whether the pane is visible in the UI or not (boolean)overlay
: Which, if any, debug tool is currently active on this panezoom
: At which zoom level a pane is showndarkUI
: If Polypane is running in dark or light mode
When running in isolate panes mode, there are additional properties:
emulation
: An object with the emulation options as applied to the pane:userAgent
,pixelRatio
,screenType
,emulateTouch
andnetwork
.extraHeaders
: a string with the extra headers being sent to this pane.
Option 3: The in-polypane
class
When running on Polypane, the HTML element will have the 'in-polypane' class applied to it, letting you style based on it.
Is your question not answered?
Ask via Twitter, Slack or our contact form
Build your next project with Polypane
- Try all plans, all features
- On Mac, Window and Linux
- 14-day free trial – no credit card needed