Skip to content
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

Added hold and double tap actions for tile card icon #21947

Conversation

martindybal
Copy link
Contributor

@martindybal martindybal commented Sep 11, 2024

Proposed change

Added icon_hold_action and icon_double_tap_action for the Tile card.
The hold and double tap actions option has been introduced in PR #18345. But the hold or double tap icon is not supported. And a hold tap on an icon invokes icon_action not hold_action.

This is probably a bug because tap was used in any action.

handleAction(this, this.hass!, config, "tap");

This pr will allow the user to apply the same hold action to the content and the icon.

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

icon_hold_action:
  action: navigate
  navigation_path: /config
icon_double_tap_action:
  action: navigate
  navigation_path: /config

Additional information

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:

Summary by CodeRabbit

  • New Features
    • Enhanced tile card interactions with new options for hold and double tap actions.
    • Expanded configuration options for tile cards to allow for more interactive user experiences.

These updates improve user engagement by enabling more nuanced control over tile card responses to gestures.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

The changes introduce new interaction capabilities to the HuiTileCard component by adding hold_action and double_tap_action properties to the configuration object. These properties allow users to define actions triggered by holding or double-tapping the tile card. Additionally, the TileCardConfig interface has been updated to include these new action configurations, ensuring that the component can handle these user gestures effectively.

Changes

Files Change Summary
src/panels/lovelace/cards/hui-tile-card.ts
src/panels/lovelace/cards/types.ts
Added hold_action and double_tap_action properties to HuiTileCard and TileCardConfig, enabling new user interaction options.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b48a28f and a317765.

Files selected for processing (2)
  • src/panels/lovelace/cards/hui-tile-card.ts (2 hunks)
  • src/panels/lovelace/cards/types.ts (1 hunks)
Additional comments not posted (4)
src/panels/lovelace/cards/types.ts (1)

501-502: LGTM!

The additions of icon_hold_action and icon_double_tap_action properties to the TileCardConfig interface are consistent with the existing code and align with the PR objective.

The changes are approved.

src/panels/lovelace/cards/hui-tile-card.ts (3)

139-140: LGTM!

The code changes are approved.


142-142: LGTM!

The code changes are approved.


291-294: LGTM!

The code changes are approved.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member

@piitaya piitaya left a comment

Choose a reason for hiding this comment

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

Thank you 🙂
We didn't add the feature because it's a pretty hidden feature but for flexibility I agree that we can have it as yaml only feature 🙂

@piitaya piitaya merged commit 68a0d04 into home-assistant:dev Sep 13, 2024
14 checks passed
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