Add hold_action to Tile card's visual config editor

[redxtech]

Proposed change

This change adds the hold_action config option to the visual editor for the tile card.

As someone who uses a lot of tiles, I almost always set both tap_action and icon_tap_action to toggle, so it makes a lot of sense to use hold_action for more-info.

Since there is only visual editor support for tap_action and icon_tap_action, it becomes fairly cumbersome and annoying to have to drop an element into YAML mode just to add a hold_action, since it removes the very capable dynamic configuration of the tile card.

As I'm fairly certain that I'm not the only one who makes extensive use of the hold_action, I feel it would make sense to include the it in the visual editor.

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

type: tile
entity: light.ceiling_light
tap_action:
  action: toggle
hold_action:
  action: more-info

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:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• New Features
  • Introduced a new optional hold_action property in the tile card editor, allowing users to define actions triggered by holding a tile.
  • Added a schema entry for hold_action, enhancing the user interface for action configuration.

[home-assistant]

Hi @redxtech

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new optional property, hold_action, to the cardConfigStruct in the tile card editor. This property allows users to define an action that occurs when a tile is held, complementing existing actions like tap_action. Additionally, a corresponding schema entry for hold_action is added, which includes a default action set to "none". This enhancement extends the functionality of the tile card editor.

Changes

File Path	Change Summary
src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts	Added a new optional property hold_action to cardConfigStruct and a schema entry for it.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fd9e2b6 and a1665ea.

Files selected for processing (1)

• src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts (2 hunks)

Additional comments not posted (2)

src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts (2)

53-53: LGTM!

The addition of the hold_action property to the cardConfigStruct is consistent with the existing action properties and is a necessary change to support the hold action functionality in the tile card.

---

161-168: LGTM!

The addition of the hold_action schema entry to the form schema is consistent with the existing action schema entries and is a necessary change to support the configuration of the hold action through the visual editor for the tile card.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>, please review it.
  -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @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.

[MindFreeze]

I agree that hold is a frequently used action but then maybe it makes sense to add icon_hold_action as well

[redxtech]

@MindFreeze if wanted, I can update the PR to add icon_hold_action, or I can open another PR for it.

@bramkragten I notice you added the Needs UX tag - is this something I need to add to the PR before merging? Are there docs/a list of requirements for this? Or is it for something/someone else?

[MindFreeze]

Need UX means that we have to discuss it with the team. Apparently hold_action in a somewhat controversial topic.

[matthiasdebaat]

As I'm fairly certain that I'm not the only one who makes extensive use of the hold_action, I feel it would make sense to include the it in the visual editor.

I agree, as it's a choice of the dashboard creator. The UX discussion we had was that the tap and hold interaction is something you need to learn.