Add "has-network" attribute #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows us to show or hide things based on network status. Allowable values are "online" or "offline". An [earlier attempt][1] at this introduced an `is-offline` attribute, but the disadvantage of this approach is that "online" is an implicit default state. The approach here puts "online" and "offline" on the same logical footing, and allows them to be combined with other conditions more easily. Note that if a value other than "offline" or "online" is provided to `has-network` it will always return false. This seemed the most consistent approach with other matchers (eg. supports, media, etc). [1]: oddbird#7
jamesnw
approved these changes
Jan 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This introduces a
has-networkattribute which allows us to show or hide things based on network status ("online" or "offline")One thing that might be worth noting: when
has-networkis present but set to an invalid value (ie. something other thanonlineoroffline) the matcher will always returnfalse. I wasn't totally sure what the best approach here was: another option would be to returnundefinedand effectively ignore the matcher, but treating other values as false seemed more consistent with how the other conditional attributes behave in cases where a value is invalid, and maybe less likely to lead to confusion where someone, eg. makes a typo.Related Issue(s)
An earlier attempt at this used an
is-offlineattribute. However, on that PR, @mirisuzanne suggested thathas-network="offline | online"might be a better syntax. I agree, because this has the advantage of putting "online" and "offline" on the same logical footing, making "online" equally targetable for showing / hiding purposes, rather than treating it as a default state.Steps to test/reproduce
Use the
has-networkattribute to show/hide based on network status: