Skip to content

Use context instead of stateObj for card features #25577

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.

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

Merged
merged 6 commits into from
May 26, 2025
Merged

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented May 23, 2025

Proposed change

Use context instead of stateObj for card features. It was already used in the editor and will open the possibility to have card features for other type of card (e.g. area card by passing an area_id)

All the HA card features has been migrated in this PR.

Custom card features needs to migrate to this new API :

  • supported: (stateObj) => boolean is replaced by isSupported: (hass, context) = boolean
  • context property is set to card features instead of stateObj

However, a backward compatibility has been added to avoid breaking change. A blog post will be written and the dev documentation will be updated.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

piitaya and others added 2 commits May 26, 2025 15:25
Co-authored-by: Bram Kragten <mail@bramkragten.nl>
@piitaya piitaya requested a review from bramkragten May 26, 2025 13:47
bramkragten
bramkragten previously approved these changes May 26, 2025
@bramkragten bramkragten enabled auto-merge (squash) May 26, 2025 13:53
@bramkragten bramkragten merged commit fcf5ed7 into dev May 26, 2025
11 checks passed
@bramkragten bramkragten deleted the card_feature_context branch May 26, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants