Cards: add visibility #33093

c0ffeeca7 · 2024-06-05T13:19:44Z

Proposed change

Cards: add visibility

related to Add visibility option to dashboard cards frontend#20840
rework procedure
add visibility option
add links to cards

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 visibility option to dashboard cards frontend#20840
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 new card types for specific devices and services (e.g., alarm, light, thermostat).
- Added grouping cards (e.g., vertical stack, horizontal stack, grid) to organize dashboards.
- Implemented logic function cards (e.g., conditional, entity filter) for dynamic content display.
- Enhanced data display options with new cards (e.g., sensor, history graph, energy).
- Added control cards for devices and entities (e.g., button, entity).
- Combined data display and control with new cards (e.g., area, picture elements, picture glance).

- Rework procedure - add links to cards - related to home-assistant/frontend#20840

netlify · 2024-06-05T13:20:00Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`ef85c32`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/666065f33ed270000809c165
😎 Deploy Preview	https://deploy-preview-33093--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 · 2024-06-05T13:20:05Z

Walkthrough

The updates to cards.markdown enhance the organization and categorization of card types within dashboards. These changes introduce links to specific device types or services, group related cards, implement logic functions, display generic data, control devices and entities, and manage the conditional visibility of cards. This reorganization aims to streamline the process of adding and managing cards in dashboards.

Changes

Files	Change Summary
`source/dashboards/cards.markdown`	Updated categorization of card types, added links to device types/services, and detailed card functionalities.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Dashboard
    participant CardManager
    
    User->>Dashboard: Request to add a card
    Dashboard->>CardManager: Forward request with card type
    CardManager->>Dashboard: Provide available card types and functionalities
    Dashboard->>User: Display card options
    User->>Dashboard: Select card and configure settings
    Dashboard->>CardManager: Save new card configuration
    CardManager->>Dashboard: Confirm card addition
    Dashboard->>User: Display updated dashboard with new card

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between ed33ba9 and ef85c32.

Files selected for processing (1)

source/dashboards/cards.markdown (1 hunks)

Additional context used

LanguageTool

source/dashboards/cards.markdown

[grammar] ~30-~30: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN)
Context: ...ecast](/dashboards/weather-forecast/), todo list, [map](/d...

[misspelling] ~30-~30: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ashboards/weather-forecast/), todo list, map, [logbook](/...

[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ... you have an idea of what card type you want to use for an entity, add By card type...

[style] ~51-~51: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...ions-add-card-by-card.png) - If you want to add cards for multiple entities at once...

[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ction is always shown, to all users. 4. If you like, define [card actions, feature...

[uncategorized] ~68-~68: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ... the Device page and want to create card directly from there. 1. Go to **{% my ...

[style] ~79-~79: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ction is always shown, to all users. 4. If you like, define [card actions, feature...

Additional comments not posted (4)

source/dashboards/cards.markdown (4)
30-30: Consider adding a hyphen to "todo list" to clarify it as a noun.
[grammar]
- [todo list](/dashboards/todo-list/)
+ [to-do list](/dashboards/todo-list/)
Tools

LanguageTool

[grammar] ~30-~30: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”? (TO_DO_HYPHEN)
Context: ...ecast](/dashboards/weather-forecast/), todo list, [map](/d...

[misspelling] ~30-~30: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ashboards/weather-forecast/), todo list, map, [logbook](/...

46-46: Consider rephrasing to add variety to your writing.
[style]
- If you have an idea of what card type you want to use for an entity, add **By card** type:
+ If you already know the card type you need for an entity, choose **By card** type:

- If you want to add cards for multiple entities at once, select **By entity**.
+ To add multiple entities at once, select **By entity**.
Also applies to: 51-51

Tools

LanguageTool

[style] ~46-~46: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ... you have an idea of what card type you want to use for an entity, add By card type...

61-61: Consider rewording to avoid repetitive sentence beginnings.
[style]
- If you like, define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).
+ You may also define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).

- If you like, define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).
+ Additionally, define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).
Also applies to: 79-79

Tools

LanguageTool

[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ction is always shown, to all users. 4. If you like, define [card actions, feature...

68-68: Consider adding an article before "card".
[uncategorized]
- want to create card directly from there.
+ want to create a card directly from there.
Tools

LanguageTool

[uncategorized] ~68-~68: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ... the Device page and want to create card directly from there. 1. Go to **{% my ...

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

c0ffeeca7 · 2024-06-05T13:35:20Z

source/dashboards/cards.markdown

-{% details "Using the Add to dashboard button on device page" %}
-
-Another way to add entities to a dashboard is to use the **Device** page.
+This method is useful if you are on the **Device** page and want to create card directly from there.


Suggested change

This method is useful if you are on the **Device** page and want to create card directly from there.

This method is useful if you are on the **Device** page and want to create a card directly from there.

frenck

Thanks, @c0ffeeca7 👍

../Frenck

Cards: update to include visibility

ef85c32

- Rework procedure - add links to cards - related to home-assistant/frontend#20840

home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jun 5, 2024

c0ffeeca7 added this to the 2024.6 milestone Jun 5, 2024

c0ffeeca7 added the parent-merged The parent PR has been merged already label Jun 5, 2024

c0ffeeca7 commented Jun 5, 2024

View reviewed changes

frenck approved these changes Jun 5, 2024

View reviewed changes

frenck merged commit b5ed4d3 into next Jun 5, 2024
8 checks passed

frenck deleted the cards-add-visibility branch June 5, 2024 13:35

home-assistant bot removed the parent-merged The parent PR has been merged already label Jun 5, 2024

c0ffeeca7 mentioned this pull request Jun 5, 2024

Card visibility: fix procedure #33097

Merged

8 tasks

frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Jun 5, 2024

frenck pushed a commit that referenced this pull request Jun 5, 2024

Cards: add visibility (#33093)

e8df5c4

github-actions bot locked and limited conversation to collaborators Jun 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cards: add visibility #33093

Cards: add visibility #33093

c0ffeeca7 commented Jun 5, 2024 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 5, 2024 •

edited

Loading

coderabbitai bot commented Jun 5, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s) (Beta)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

c0ffeeca7 Jun 5, 2024

frenck left a comment

	This method is useful if you are on the Device page and want to create card directly from there.
	This method is useful if you are on the Device page and want to create a card directly from there.

Cards: add visibility #33093

Cards: add visibility #33093

Conversation

c0ffeeca7 commented Jun 5, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

netlify bot commented Jun 5, 2024 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Jun 5, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s) (Beta)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

c0ffeeca7 Jun 5, 2024

Choose a reason for hiding this comment

frenck left a comment

Choose a reason for hiding this comment

c0ffeeca7 commented Jun 5, 2024 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 5, 2024 •

edited

Loading

coderabbitai bot commented Jun 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)