Skip to content

Support progress styling keys on Android #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
inukiwi wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Support progress styling keys on Android #317

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24592ac
Add new progress-related keys to android.js
inukiwi Mar 23, 2026
80d0d44
Merge branch 'home-assistant:main' into feature/android_progress_styling
inukiwi Jun 12, 2026
850ae95
Use JSON to flatten objects and lists in notification data
inukiwi Jun 15, 2026
4428a07
Merge branch 'home-assistant:main' into feature/android_progress_styling
inukiwi Jun 17, 2026
b8496ae
Move object serialization code
inukiwi Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion functions/android.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,25 @@ module.exports = {
'progress_indeterminate',
'live_update',
'critical_text',
'progress_segments',
'progress_points',
'progress_start_icon',
'progress_end_icon',
'progress_tracker_icon',
'progress_start_color',
'progress_end_color',
'progress_tracker_color',
Comment on lines +116 to +123

@TimoPtr TimoPtr Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like this to be verify with @bgoncal to see if iOS can use them like this or if it's specific to Android.

@bgoncal bgoncal Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you worried about the data structure or the keys themselves?
iOS will have to map them in the file (currently called) legacy.js anyways so, as long it comes from the user's yaml payload iOS can deal with it.

If the question is regard if iOS can use these keys to create the UI, yes it can, in iOS the live activity is kinda white board, we can draw anything (non-animated) in there, but I havent reviewed the way this is being designed for the user to use, I mean.. is there a more clever way? But then it's better to read the docs to see if it is intuitive enough for the user.

@TimoPtr TimoPtr Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's discuss in home-assistant/companion.home-assistant#1297 the idea is to validate the fields also for you if you can use them later.

];

androidNotificationKeys.forEach((key) => {
if (Object.hasOwn(req.body.data, key)) {
payload.data[key] = String(req.body.data[key]);
// If the value is an object, stringify it. Convert everything else to a string.
// This is because FCM data payloads must be strings.
if (typeof req.body.data[key] === 'object') {
payload.data[key] = JSON.stringify(req.body.data[key]);
} else {
payload.data[key] = String(req.body.data[key]);
}
Comment on lines +128 to +134

@TimoPtr TimoPtr Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you consider this?

@inukiwi inukiwi Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the preferred approach would be option a, since option b would just silently fail with no means to debug.
I'll update handlers.js to include some error handling and returning it to Home Assistant

}
});
}
Expand Down