Skip to content

Commit 1ea53c1

Browse files
authored
[docs] add home widgets documentation (#8629)
## Description ## Tests
2 parents 399a45a + bcfa5e8 commit 1ea53c1

File tree

3 files changed

+237
-0
lines changed

3 files changed

+237
-0
lines changed

docs/docs/.vitepress/sidebar.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,10 @@ export const sidebar = [
214214
text: "Detect Text (OCR)",
215215
link: "/photos/features/utilities/detect-text",
216216
},
217+
{
218+
text: "Home Widgets",
219+
link: "/photos/features/utilities/home-widgets",
220+
},
217221
{
218222
text: "Notifications",
219223
link: "/photos/features/utilities/notifications",

docs/docs/photos/faq/advanced-features.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,80 @@ Notifications are currently only available on mobile apps. See the [Notification
270270

271271
Open `Settings > General > Notifications` to enable or disable specific notification categories. All categories are enabled by default when you grant notification permission.
272272

273+
## Home Widgets
274+
275+
### How do I add a home widget? {#add-home-widget}
276+
277+
**On iOS:**
278+
279+
1. Long press on your home screen until apps start jiggling
280+
2. Tap the **+** button in the top left corner
281+
3. Search for "Ente" or scroll to find Ente Photos
282+
4. Choose the widget type (Memories, Albums, or People)
283+
5. Select your preferred widget size
284+
6. Tap **Add Widget**
285+
286+
**On Android:**
287+
288+
1. Long press on an empty area of your home screen
289+
2. Tap **Widgets**
290+
3. Find and expand **Ente Photos**
291+
4. Long press your desired widget and drag it to your home screen
292+
293+
Learn more in the [Home Widgets guide](/photos/features/utilities/home-widgets).
294+
295+
### How do I configure which albums appear on my widget? {#configure-widget-albums}
296+
297+
Open `Settings > General > Home widget > Albums widget` in the Ente app.
298+
299+
From here, you can select which albums to display. By default, the **Favorites** album is selected. You can select multiple albums to show more variety on your home screen.
300+
301+
Learn more in the [Home Widgets guide](/photos/features/utilities/home-widgets#configuring-the-albums-widget).
302+
303+
### Why does the People widget require face recognition? {#people-widget-face-recognition}
304+
305+
The People widget displays photos of specific people from your library. To identify people in your photos, Ente needs to use face recognition, which is part of the machine learning features.
306+
307+
To use the People widget:
308+
309+
1. Enable face recognition in `Settings > General > Advanced > Machine learning`
310+
2. Wait for face indexing to complete
311+
3. Open `Settings > General > Home widget > People widget` to select people
312+
313+
Learn more about [Face recognition](/photos/features/search-and-discovery/face-recognition).
314+
315+
### How often do widgets refresh? {#widget-refresh-rate}
316+
317+
Widgets automatically refresh approximately every **15 minutes**. This refresh happens in the background by the operating system, so you'll see different photos throughout the day without manual intervention.
318+
319+
Opening the Ente app also triggers a widget sync, which can update your widgets sooner.
320+
321+
### Widget not showing photos {#widget-not-showing-photos}
322+
323+
If your widget appears blank or isn't showing photos:
324+
325+
1. **Open the Ente app** and wait for it to sync completely
326+
2. **Check your configuration** - ensure you have photos in the configured albums or people
327+
3. **Verify storage** - make sure your device has enough storage for widget cache
328+
4. **Remove and re-add the widget** to force a refresh
329+
5. **Check background app refresh** - ensure Ente is allowed to refresh in the background in your device settings
330+
331+
If the People widget shows no options, make sure face recognition is enabled and has finished indexing your photos.
332+
333+
### What types of memories appear in the Memories widget? {#memories-widget-types}
334+
335+
The Memories widget can display three types of memories:
336+
337+
- **On This Day**: Photos from the same date in previous years
338+
- **Past Years**: Memories from past years
339+
- **Smart Memories**: AI-curated memorable moments
340+
341+
You can toggle which memory types appear by opening `Settings > General > Home widget > Memories widget`.
342+
343+
### Are widgets available on desktop or web? {#widgets-platform-availability}
344+
345+
No, home widgets are only available on mobile apps (iOS and Android). Desktop apps and web browsers do not support home screen widgets.
346+
273347
## Other Advanced Features
274348

275349
### Can I access Ente from multiple browsers? {#multiple-browsers}
Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
title: Home Widgets
3+
description: Add beautiful photo widgets to your phone's home screen with Ente Photos
4+
---
5+
6+
# Home Widgets
7+
8+
Ente Photos offers home screen widgets that display your photos directly on your phone's home screen. Widgets automatically refresh with new photos from your library, bringing your memories to life throughout the day.
9+
10+
> **Note**: Home widgets are available on mobile apps only (iOS and Android).
11+
12+
## Widget Types
13+
14+
Ente provides three types of home screen widgets:
15+
16+
### Memories Widget
17+
18+
Displays photos from your memories, including:
19+
20+
- **On This Day**: Photos from the same date in previous years
21+
- **Past Years**: Memories from past years
22+
- **Smart Memories**: AI-curated memorable moments
23+
24+
The Memories widget automatically rotates through your memories, surfacing nostalgic moments right on your home screen.
25+
26+
### Albums Widget
27+
28+
Shows photos from your selected albums. By default, it displays photos from your **Favorites** album, but you can customize which albums to include.
29+
30+
### People Widget
31+
32+
Displays photos featuring selected people from your library. This widget helps you keep photos of your loved ones front and center.
33+
34+
**Requirement**: The People widget requires [face recognition](/photos/features/search-and-discovery/face-recognition) to be enabled. You must first enable machine learning and allow face recognition to detect and group people in your photos.
35+
36+
## Adding Widgets to Your Home Screen
37+
38+
### On iOS
39+
40+
1. Long press on your home screen until apps start jiggling
41+
2. Tap the **+** button in the top left corner
42+
3. Search for "Ente" or scroll to find Ente Photos
43+
4. Choose the widget type (Memories, Albums, or People)
44+
5. Select your preferred widget size
45+
6. Tap **Add Widget**
46+
7. Position the widget and tap **Done**
47+
48+
### On Android
49+
50+
1. Long press on an empty area of your home screen
51+
2. Tap **Widgets**
52+
3. Find and expand **Ente Photos**
53+
4. Long press your desired widget and drag it to your home screen
54+
5. Resize the widget if needed
55+
56+
## Configuring Widgets
57+
58+
### Widget Settings
59+
60+
Open `Settings > General > Home widget` in the Ente app to configure your widgets.
61+
62+
### Configuring the Albums Widget
63+
64+
1. Open `Settings > General > Home widget > Albums widget`
65+
2. Select which albums you want to display on your home screen
66+
3. By default, the **Favorites** album is selected
67+
4. You can select multiple albums to include more variety
68+
69+
### Configuring the People Widget
70+
71+
1. Open `Settings > General > Home widget > People widget`
72+
2. Select which people you want to feature
73+
3. Only people detected by face recognition will appear as options
74+
75+
> **Note**: You must enable [face recognition](/photos/features/search-and-discovery/face-recognition) before configuring the People widget.
76+
77+
### Configuring the Memories Widget
78+
79+
1. Open `Settings > General > Home widget > Memories widget`
80+
2. Toggle which memory types to include:
81+
- **On This Day**: Photos from this date in previous years
82+
- **Past Years**: Yearly memories
83+
- **Smart Memories**: AI-curated memorable moments
84+
85+
## How Widgets Work
86+
87+
### Data Synchronization
88+
89+
Widgets sync photos from your Ente library to your device's widget storage:
90+
91+
1. The app selects photos based on your widget configuration
92+
2. Thumbnails are rendered and cached locally (512px resolution)
93+
3. Up to 50 photos are cached per widget type
94+
4. Widgets read from this local cache to display photos
95+
96+
### Automatic Refresh
97+
98+
Widgets automatically refresh approximately every **15 minutes** to display new photos. The refresh happens in the background, so you'll see different photos throughout the day without any manual intervention.
99+
100+
### Tapping Widgets
101+
102+
When you tap a photo on a widget:
103+
104+
- The Ente app opens directly to that photo
105+
- For Memories widgets, you'll see the memory collection
106+
- For Albums widgets, you'll see the photo in its album context
107+
- For People widgets, you'll see photos of that person
108+
109+
## Tips for Best Experience
110+
111+
### Ensure Photos Are Backed Up
112+
113+
Widgets display photos that are backed up to Ente. Make sure your photos are synced for the best widget experience.
114+
115+
### Enable Face Recognition Early
116+
117+
If you want to use the People widget, enable face recognition in advance so the app can detect and group faces in your photos.
118+
119+
Open `Settings > General > Advanced > Machine learning` and enable face recognition.
120+
121+
### Keep the App Updated
122+
123+
Widget improvements are released regularly. Keep the Ente app updated for the best performance and new features.
124+
125+
### Add Favorite Photos
126+
127+
The Albums widget defaults to your Favorites album. Add photos to Favorites by tapping the heart icon on any photo. This ensures your most cherished photos appear on your home screen.
128+
129+
## Platform Availability
130+
131+
| Platform | Home Widgets |
132+
| ----------- | ---------------- |
133+
| iOS app | ✅ Supported |
134+
| Android app | ✅ Supported |
135+
| Desktop app | ❌ Not available |
136+
| Web browser | ❌ Not available |
137+
138+
## Privacy and Security
139+
140+
Home widgets maintain Ente's privacy standards:
141+
142+
- **Local storage**: Widget images are stored locally on your device
143+
- **Encrypted sync**: Data synced from Ente servers is end-to-end encrypted
144+
- **No external access**: Widget data is only accessible by the Ente app and system widget framework
145+
- **Secure deep links**: Tapping widgets uses secure internal links to open photos
146+
147+
## Related FAQs
148+
149+
- [How do I add a home widget?](/photos/faq/advanced-features#add-home-widget)
150+
- [How do I configure which albums appear on my widget?](/photos/faq/advanced-features#configure-widget-albums)
151+
- [Why does the People widget require face recognition?](/photos/faq/advanced-features#people-widget-face-recognition)
152+
- [How often do widgets refresh?](/photos/faq/advanced-features#widget-refresh-rate)
153+
- [Widget not showing photos](/photos/faq/advanced-features#widget-not-showing-photos)
154+
155+
## Related Topics
156+
157+
- [Face recognition guide](/photos/features/search-and-discovery/face-recognition)
158+
- [Machine learning guide](/photos/features/search-and-discovery/machine-learning)
159+
- [Notifications](/photos/features/utilities/notifications)

0 commit comments

Comments
 (0)