Add support for showing a local file

Plash

Make any website your Mac desktop wallpaper

Plash enables you to have a highly dynamic desktop wallpaper. You could display your favorite news site, Facebook feed, or a random beautiful scenery photo. The use-cases are limitless. You could even set an animated GIF as wallpaper. You can even add multiple websites and easily switch between them.

Use-cases

Random Unsplash image
Example: https://source.unsplash.com/random/2880x1756?puppy
This returns a new random puppy image each time. See the tip on how to get exact screen size.
Bing Photo of the Day
Calendar
For example, Google Calendar or Outlook 365.
Personal stats
You could even make a custom website for this.
Random street view image
Animated GIF
Example: https://media3.giphy.com/media/xTiTnLmaxrlBHxsMMg/giphy.gif?cid=790b761121c10e72aca8bcfe50b030502b62a69ac7336782&rid=giphy.gif
Random color
Build a custom website
You could build something quick and host it on GitHub Pages, jsfiddle, or CodePen.

Share your use-case

Features

Show a remote or local website
Interact with the website (“Browsing Mode”)
Automatically reload the website at a custom interval
Add multiple websites
Show the website on a different display
Invert website colors (fake dark mode)
Add custom CSS and JavaScript to the website
Lower the opacity
Transparent background
Automatically deactivate while on battery
Audio is muted
Single image will be aspect-filled to your screen
Hide menu bar icon
Shortcuts support
Scriptable
Share extension

Download

Requires macOS 14 or later.

Older versions

2.14.1 for macOS 13+
2.12.1 for macOS 12+
2.10.1 for macOS 11+
2.1.0 for macOS 10.15+

Non-App Store version

A special version for users that cannot access the App Store. It won't receive automatic updates. I will update it here once a year.

Download (2.15.0 · macOS 14+)

Tips

Browsing mode

You can interact with the website by enabling “Browsing Mode”. When in this mode, you can right-click to be able to go back/forward, reload, and zoom in the page contents (the zoom level is saved). You can also pinch to magnify. This is different from zooming the page contents in that it will zoom in to a specific part of the page instead of just enlarging everything.

Plash injects a CSS class named plash-is-browsing-mode on the <html> element while browsing mode is active. You could use this class to customize the website for browsing mode.

If clicking a link opens it in a new window, you can hold the Option key while clicking the link to open it in the main Plash window.

Zoom in website

To zoom in the website, activate “Browsing Mode”, right-click the website, and then select “Zoom In”.

URL placeholders for screen width and height

Use [[screenWidth]] and [[screenHeight]] in any URL and Plash will substitute the right values for you. For example, https://source.unsplash.com/random/[[screenWidth]]x[[screenHeight]]?puppy.

Scroll to position

You can scroll a website to a specific position each time it is loaded by putting the following in the website's “JavaScript” field. Adjust the “500” to how far down it should scroll.

window.scrollTo(0, 500);

You can also scroll to a specific element matching a CSS selector:

document.querySelector('.title')?.scrollIntoView();

Make the website occupy only half the screen

You can use the “CSS” field in the website settings to adjust the padding of the website:

:root {
    margin-left: 50% !important;
}

Detect Plash

Plash injects a CSS class named is-plash-app on the <html> element. You could use this class to customize your website for Plash. For example, if your website has instructions on how to use it in Plash, you could hide those when it's running in Plash.

Screenshots

Scripting

You can control Plash using anything that supports opening a URL with a custom scheme.

For example, to reload the current website, run this terminal command:

$ open -g plash:reload

Share extension

Plash comes bundled with a share extension. You can, for example, use it to quickly add a website you have open in Safari to Plash.

Tools

plash-cli - Command-line tool.
alfred-plash - Alfred workflow.
Raycast commands

Commands

`add`

Add a website to Plash.

You can optionally specify a title. If no title is given, a title will be automatically fetched from the website.

$ open -g 'plash:add?url=https://sindresorhus.com/plash&title=Plash%20website'

Don't forget to correctly encode query parameters.

Note: Local file URLs are not supported.

`reload`

Reload the current website.

$ open -g plash:reload

`next`

Switch to the next website in the list.

$ open -g plash:next

`previous`

Switch to the previous website in the list.

$ open -g plash:previous

`random`

Switch to a random website in the list.

It will never show the same website twice in a row, unless you only have a single website.

$ open -g plash:random

`toggle-browsing-mode`

Toggle browsing mode.

$ open -g plash:toggle-browsing-mode

Examples

Node.js

import {execFileSync} from 'node:child_process';

execFileSync('open', ['--background', 'plash:reload']);

Swift

import Cocoa

let command = "plash:reload"

let configuration = NSWorkspace.OpenConfiguration()
configuration.activates = false
NSWorkspace.shared.open(URL(string: command)!, configuration: configuration)

AppleScript

do shell script "open --background 'plash:reload'"

Python

import subprocess

subprocess.run(['open', '--background', 'plash:reload'])

FAQ

The app does not show up in the menu bar

macOS hides menu bar apps when there is no space left in the menu bar. This is a common problem on MacBooks with a notch. Try quitting some menu bar apps to free up space. If this does not solve it, try quitting Bartender if you have it installed.

Can it automatically switch websites every 10 minutes?

Plash can be automated with the built-in Shortcuts app, for example, using the “Switch to Next Website” action. Shortcuts on macOS does not yet support automations, but for now, you can use the Shortery app.

Does it support multiple displays?

Support for multiple displays is currently limited to the ability to choose which display to show the website on. Support for setting a separate website for each display is planned.

However, I there is a workaround.

Why does Plash use so much memory?

Plash uses very little memory. Usually around 40 MB. However, the websites you display can take up a lot of memory, and sometimes even have a memory leaks.

The menu bar does not adapt to the Plash wallpaper

The menu bar adapts its color from the actual system wallpaper. Plash is not actually a wallpaper, but rather runs right above the wallpaper. So Plash cannot influence the menu bar color.

Can Plash block ads?

Not built-in, but you can block ads system-wide with a DNS ad-blocker.

How can I switch to a specific website with a keyboard shortcut?

Make a shortcut in the Shortcuts app that uses the “Set Current Website” action and then set a keyboard shortcut for the shortcut.

Can I contribute localizations?

I don't have any immediate plans to localize the app.

What does “Plash” mean?

Click here.

Built with

Defaults - Swifty and modern UserDefaults
KeyboardShortcuts - Add user-customizable global keyboard shortcuts to your macOS app

Links

More apps by me

	// TODO: This requires some more work.
	// - Need to save the security scoped bookmark in UserDefaults after the open panel so the file can be accessed on the next launch.
	// - WKWebView has a bug where it can only load a local file once. We need to work around that.
	// - See inline TODOs.
	menu.addCallbackItem(
	"Open File…",
	key: "o",
	keyModifiers: .option,
	isHidden: true // TODO: Disabled until it's done.
	) { _ in
	NSApp.activate(ignoringOtherApps: true)

	let panel = NSOpenPanel()
	panel.canChooseDirectories = false
	panel.canCreateDirectories = false

	// Ensure it's above the window when in "Browsing Mode".
	panel.level = .floating

	// TODO: Limit file types to only what WKWebView supports? Where can we find out what it supports?
	//panel.allowedFileTypes = []

	if
	let url = Defaults[.url],
	url.isFileURL
	{
	panel.directoryURL = url.deletingLastPathComponent()
	}

	panel.begin {
	if $0 == .OK {
	Defaults[.url] = panel.url!
	}
	}
	}

	// TODO: Add a callback to `loadURL` when it's done loading instead.
	// TODO: Fade in the web view.
	delay(seconds: 1) {
	self.desktopWindow.contentView?.isHidden = false
	}

	func showWelcomeScreenIfNeeded() {
	guard App.isFirstLaunch else {
	return
	}

	NSApp.activate(ignoringOtherApps: true)
	NSAlert.showModal(
	message: "Welcome to Plash!",
	informativeText: "Plash lives in the menu bar (droplet icon). Click it and then select “Open URL…” to get started.\n\nIf you have any feedback, bug reports, or feature requests, kindly use the “Send Feedback” button in the Plash menu. We respond to all submissions and reported issues will be dealt with swiftly. It's preferable that you report bugs this way rather than as an App Store review, since the App Store will not allow us to contact you for more information."
	)
	}

sindresorhus / plash Goto Github PK

plash's Introduction