Skip to content

Instantly share code, notes, and snippets.

@mzeryck
Last active July 1, 2024 02:24
Show Gist options
  • Save mzeryck/3a97ccd1e059b3afa3c6666d27a496c9 to your computer and use it in GitHub Desktop.
Save mzeryck/3a97ccd1e059b3afa3c6666d27a496c9 to your computer and use it in GitHub Desktop.
A Scriptable script that creates "invisible" widget backgrounds based on your iOS wallpaper, and then either uses them as a Scriptable widget background or exports to your camera roll.
/*
MIT License
Copyright (c) 2022 Maxwell Zeryck
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
// Widgets are unique based on the name of the script.
const filename = Script.name() + ".jpg"
const files = FileManager.local()
const path = files.joinPath(files.documentsDirectory(), filename)
if (config.runsInWidget) {
let widget = new ListWidget()
widget.backgroundImage = files.readImage(path)
// You can your own code here to add additional items to the "invisible" background of the widget.
Script.setWidget(widget)
Script.complete()
/*
* The code below this comment is used to set up the invisible widget.
* ===================================================================
*/
} else {
// Determine if user has taken the screenshot.
var message
message = "Before you start, go to your home screen and enter wiggle mode. Scroll to the empty page on the far right and take a screenshot."
let exitOptions = ["Continue","Exit to Take Screenshot"]
let shouldExit = await generateAlert(message,exitOptions)
if (shouldExit) return
// Get screenshot and determine phone size.
let img = await Photos.fromLibrary()
let height = img.size.height
let phone = phoneSizes()[height]
if (!phone) {
message = "It looks like you selected an image that isn't an iPhone screenshot, or your iPhone is not supported. Try again with a different image."
await generateAlert(message,["OK"])
return
}
// Extra setup needed for 2436-sized phones.
if (height == 2436) {
let cacheName = "mz-phone-type"
let cachePath = files.joinPath(files.libraryDirectory(), cacheName)
// If we already cached the phone size, load it.
if (files.fileExists(cachePath)) {
let typeString = files.readString(cachePath)
phone = phone[typeString]
// Otherwise, prompt the user.
} else {
message = "What type of iPhone do you have?"
let types = ["iPhone 12 mini", "iPhone 11 Pro, XS, or X"]
let typeIndex = await generateAlert(message, types)
let type = (typeIndex == 0) ? "mini" : "x"
phone = phone[type]
files.writeString(cachePath, type)
}
}
// Prompt for widget size and position.
message = "What size of widget are you creating?"
let sizes = ["Small","Medium","Large"]
let size = await generateAlert(message,sizes)
let widgetSize = sizes[size]
message = "What position will it be in?"
message += (height == 1136 ? " (Note that your device only supports two rows of widgets, so the middle and bottom options are the same.)" : "")
// Determine image crop based on phone size.
let crop = { w: "", h: "", x: "", y: "" }
if (widgetSize == "Small") {
crop.w = phone.small
crop.h = phone.small
let positions = ["Top left","Top right","Middle left","Middle right","Bottom left","Bottom right"]
let position = await generateAlert(message,positions)
// Convert the two words into two keys for the phone size dictionary.
let keys = positions[position].toLowerCase().split(' ')
crop.y = phone[keys[0]]
crop.x = phone[keys[1]]
} else if (widgetSize == "Medium") {
crop.w = phone.medium
crop.h = phone.small
// Medium and large widgets have a fixed x-value.
crop.x = phone.left
let positions = ["Top","Middle","Bottom"]
let position = await generateAlert(message,positions)
let key = positions[position].toLowerCase()
crop.y = phone[key]
} else if(widgetSize == "Large") {
crop.w = phone.medium
crop.h = phone.large
crop.x = phone.left
let positions = ["Top","Bottom"]
let position = await generateAlert(message,positions)
// Large widgets at the bottom have the "middle" y-value.
crop.y = position ? phone.middle : phone.top
}
// Crop image and finalize the widget.
let imgCrop = cropImage(img, new Rect(crop.x,crop.y,crop.w,crop.h))
message = "Your widget background is ready. Would you like to use it as this script's background, or export the image for use in a different script or another widget app?"
const exportPhotoOptions = ["Use for this script","Export to Photos","Export to Files"]
const exportPhoto = await generateAlert(message,exportPhotoOptions)
if (exportPhoto == 0) {
files.writeImage(path,imgCrop)
} else if (exportPhoto == 1) {
Photos.save(imgCrop)
} else if (exportPhoto == 2) {
await DocumentPicker.exportImage(imgCrop)
}
Script.complete()
}
// Generate an alert with the provided array of options.
async function generateAlert(message,options) {
let alert = new Alert()
alert.message = message
for (const option of options) {
alert.addAction(option)
}
let response = await alert.presentAlert()
return response
}
// Crop an image into the specified rect.
function cropImage(img,rect) {
let draw = new DrawContext()
draw.size = new Size(rect.width, rect.height)
draw.drawImageAtPoint(img,new Point(-rect.x, -rect.y))
return draw.getImage()
}
// Pixel sizes and positions for widgets on all supported phones.
function phoneSizes() {
let phones = {
// 14 Pro Max
"2796": {
small: 510,
medium: 1092,
large: 1146,
left: 99,
right: 681,
top: 282,
middle: 918,
bottom: 1554
},
// 14 Pro
"2556": {
small: 474,
medium: 1014,
large: 1062,
left: 82,
right: 622,
top: 270,
middle: 858,
bottom: 1446
},
// 13 Pro Max, 12 Pro Max
"2778": {
small: 510,
medium: 1092,
large: 1146,
left: 96,
right: 678,
top: 246,
middle: 882,
bottom: 1518
},
// 13, 13 Pro, 12, 12 Pro
"2532": {
small: 474,
medium: 1014,
large: 1062,
left: 78,
right: 618,
top: 231,
middle: 819,
bottom: 1407
},
// 11 Pro Max, XS Max
"2688": {
small: 507,
medium: 1080,
large: 1137,
left: 81,
right: 654,
top: 228,
middle: 858,
bottom: 1488
},
// 11, XR
"1792": {
small: 338,
medium: 720,
large: 758,
left: 55,
right: 437,
top: 159,
middle: 579,
bottom: 999
},
// 13 mini, 12 mini / 11 Pro, XS, X
"2436": {
x: {
small: 465,
medium: 987,
large: 1035,
left: 69,
right: 591,
top: 213,
middle: 783,
bottom: 1353,
},
mini: {
small: 465,
medium: 987,
large: 1035,
left: 69,
right: 591,
top: 231,
middle: 801,
bottom: 1371,
}
},
// Plus phones
"2208": {
small: 471,
medium: 1044,
large: 1071,
left: 99,
right: 672,
top: 114,
middle: 696,
bottom: 1278
},
// SE2 and 6/6S/7/8
"1334": {
small: 296,
medium: 642,
large: 648,
left: 54,
right: 400,
top: 60,
middle: 412,
bottom: 764
},
// SE1
"1136": {
small: 282,
medium: 584,
large: 622,
left: 30,
right: 332,
top: 59,
middle: 399,
bottom: 399
},
// 11 and XR in Display Zoom mode
"1624": {
small: 310,
medium: 658,
large: 690,
left: 46,
right: 394,
top: 142,
middle: 522,
bottom: 902
},
// Plus in Display Zoom mode
"2001" : {
small: 444,
medium: 963,
large: 972,
left: 81,
right: 600,
top: 90,
middle: 618,
bottom: 1146
},
}
return phones
}
@Duckbilled
Copy link

Duckbilled commented Feb 12, 2021

7500487F-AF59-41B0-9A98-83421AEA963D
I have one problem... How to fix it?

I have the same issue, have you managed to fix it?

i think the code in the scriptable gallery just doesn’t really work well :)

@CaractacusPott
Copy link

@mzeryck this is really an excellent widget. Is there any chance you would consider adding a permissive license such as MIT to it just so other developers could get clarity? Regardless - huge fan of this (wish Apple would've included it out of the box!). Thanks.

@thonkinator
Copy link

thanks to iPadOS 15, iPads now have their widgets on the home screen like iOS. because of this, i was wondering if there'll ever be a version that supports iPads?

@bcmadsen
Copy link

I would love to see this for iPad too!

@Kyxrem
Copy link

Kyxrem commented Sep 24, 2021

Here are the values for the iPhone 13
"2532": {
"small": 474,
"medium": 1014,
"large": 1062,
"left": 78,
"right": 618,
"top": 231,
"middle": 819,
"bottom": 1407
},

@Kyxrem
Copy link

Kyxrem commented Sep 25, 2021

I created a new page with lots of small widgets. Preferably black widgets like the clock and a white background. Afterwards you take a screenshot of that page, load it up to you computer and open the image with some image manipultaion tool. I choose GIMP. In GIMP you can draw rectangles and it will tell you the position of the top-left corner of the rectangle and the size.
In my case, 2532 is the height of the phone.
"small" is the width of a small widget.
"medium" is the with of a medium widget.
"large" is the height of a large widget.
"left" is the distance from the left side of the screenshot to the left side of a widget on the left side.
"right" is the distance from the left side of the screenshot to the left side of a widget on the right side.
"top" is the distance from the top of the screenshot to the first row of widgets.
"middle" is the distance from the top of the screenshot to the second row of widgets.
"bottom" is the distance from the top of the screenshot to the third row of widgets.

Hope that helps. If you still have any questions just ask.

@Nathaniell1
Copy link

Nathaniell1 commented Sep 26, 2021

Thank you. I figured it out in the meantime - hence the deleted post + realized your positions are same as for iphone 12. When I tried it I also got the same positions as for 13 mini. But still, my widgets are never exact... its always pixel or more wrong. Don't know where is a problem.

Edit: It seems like that the widget picture is ever so slightly zoomed in. From my testing it seems like picture is being stretched by 5px in every direction.

Edit2: Ok everything is working now. Previously I was just saving the image generated by the script and used it with other widget apps.. This produced the wrongly - zoomed image. When you instead save the image to be used by the script, then on Home screen Add widget -> Scriptable. Then edit widget and pick up this script -> pick this script -> The picture is perfect. Only drawback of this is that you will have "|Scriptable" under your widget which is a bummer (I also tried using Yidget, which has only "-" as its name and that looked much better)

@YoungGun821
Copy link

Here are the values for the iPhone 13
"2532": {
"small": 474,
"medium": 1014,
"large": 1062,
"left": 78,
"right": 618,
"top": 231,
"middle": 819,
"bottom": 1407
},

13 Pro Max here. I am no coder. I placed it in, tried to run it and it's still not recognizing the screenshots. What am I doing wrong?

@ImLvna
Copy link

ImLvna commented Oct 19, 2021

13 Pro Max here. I am no coder. I placed it in, tried to run it and it's still not recognizing the screenshots. What am I doing wrong?

13 Pro Max is bigger than the base 13 model. The values would be different between the two

@Unchanged-Is-Changed
Copy link

Margin is changed in iOS 15,Does anyone have new data

@Hucksleyy91
Copy link

iPhone 13 pro max user here
Can someone help me with adding support for the 13 pro max :-)

@SgtPooki
Copy link

how do you set the background image for a widget…?

@mzeryck
Copy link
Author

mzeryck commented Mar 15, 2022

@CaractacusPott I'm only a year late - but I did finally add the MIT license to this gist and my more full-fledged transparency project.

@YoungGun821 @Unchanged-Is-Changed @Hucksleyy91 Does anyone know how the margins/sizing changed with the 13 Pro Max? It seems to work fine as-is with my 13 Pro, but I don't have access to a Max to test with. A screenshot like this full of small widgets would be very helpful.

For anyone else looking at this thread - this Gist is an older version of what is now Widget Blur, which does transparency but also a blurring effect similar to Apple's Batteries widget.

@Enzino57
Copy link

No work with iOS 16 and iPhone 14 Pro Max

@mzeryck
Copy link
Author

mzeryck commented Sep 28, 2022

@Enzino57 Just updated the code - let me know if it's working as expected now!

@Enzino57
Copy link

Perfect. Thank you 👍🏻

@mcnahum
Copy link

mcnahum commented Sep 28, 2022

Working perfectly on iPhone 14 pro

@tokyno
Copy link

tokyno commented Oct 25, 2022

Hi, I just downloaded new version of blurred widgets script for iPhone 14 Pro, but I am missing option to choose blurred background (dark or light). Im just getting transparent background. Can someone help me with that please?

@kasimok
Copy link

kasimok commented Dec 13, 2022

If anyone wants a Swift Version of above code, check https://github.com/kasimok/Translucent

@sp2601
Copy link

sp2601 commented Sep 14, 2023

Any possibility of support for iPad Air 4th generation? Thanks!

@akamatkar08
Copy link

Initially was working just fine on the 15 Pro with iOS 17.2, but now the image is no longer show up. Script still runs, but the background isn’t there.

14 Pro and 15 Pro displays are the same so idk what changed.

@NIKO798
Copy link

NIKO798 commented Jul 1, 2024

iOS18 changed the size and location of the widget on all devices, and the homepage has an additional mode with "no app name" that also changes the location and size, all of which are now offset on iOS18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment