Describe confirmation options for button entities rows

[karwosts]

Proposed change

Describe feature implemented in home-assistant/frontend#21453

Type of change

• Spelling, grammar or other readability improvements (current branch).
• Adjusted missing or incorrect information in the current documentation (current branch).
• Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: Add confirmations to some interactive entity-rows frontend#21453
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features
  • Introduced a confirmation option in the YAML configuration for entities, allowing users to add a confirmation dialog for button actions.
• Documentation
  • Updated documentation to include details about the new confirmation option, enhancing user understanding of its purpose and configuration.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	d3c09da
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6720835257a06f0008001a5a
😎 Deploy Preview	https://deploy-preview-35436--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes introduce a new optional configuration option called confirmation in the YAML configuration for entities within the entities card documentation. This option is intended for entities that feature a button element, allowing for a confirmation dialog to appear when the button is pressed. The integration of this option does not affect the existing structure of the YAML configuration, ensuring that previous definitions remain unchanged.

Changes

File	Change Summary
source/_dashboards/entities.markdown	Added a new optional configuration option confirmation for button elements, allowing a confirmation dialog on button press.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Button
    participant ConfirmationDialog

    User->>Button: Press button
    Button->>ConfirmationDialog: Show confirmation dialog
    ConfirmationDialog-->>User: Request confirmation
    User->>ConfirmationDialog: Confirm action
    ConfirmationDialog-->>Button: Execute action

Loading

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

source/_dashboards/entities.markdown (1)

118-121: Consider adding an example demonstrating the confirmation option.

While the documentation is clear, adding an example would help users understand how to implement this feature. You could add it to the "Examples" section, showing how to configure a confirmation dialog for a button entity.

Example suggestion:

type: entities
entities:
  - entity: button.restart_server
    confirmation:
      text: Are you sure you want to restart the server?
      exemptions:
        - user: admin_user

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cda8396 and dbbdea2.

📒 Files selected for processing (1)

• source/_dashboards/entities.markdown (1 hunks)

🔇 Additional comments (1)

source/_dashboards/entities.markdown (1)

118-121: LGTM! Configuration documentation is clear and well-structured.

The new confirmation option is well-documented with clear description of its purpose and applicability. The cross-reference to detailed configuration options is appropriate.

[c0ffeeca7]

Thank you, @karwosts 👍