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

Implement show_empty functionality for the markdown card #21379

Merged
merged 14 commits into from
Jul 31, 2024

Conversation

illuzn
Copy link
Contributor

@illuzn illuzn commented Jul 12, 2024

Proposed change

This implements show_empty: true/ false functionality for the markdown card. The functionality is similar to the entity filter card.

This resolves a requested feature here (https://www.reddit.com/r/homeassistant/comments/y2nwz0/hide_markdown_card_if_empty/) for which there are no appropriate solutions.

It is possible using templates to create conditions which far exceed the capability of the conditional card or the "visibility" settings of cards so this functionality is required. For example, you currently cannot toggle visibility based on an attribute of a card currently.

The workaround suggested in that reddit thread (using a template sensor and outputting to state) isn't appropriate because the text output from a markdown card can exceed the maximum of 255 characters.

There is no existing translation in the entity filter card for "show_empty" so the visual editor couldn't be implmented in this case.

By default, the existing behaviour is kept i.e. an empty card is shown which results in a small empty box.

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: markdown
content: '{{ "Hello World" if 1 == 2 }}'
show_empty: false

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 Markdown card configuration with a new show_empty option to control card visibility when there are no results.
    • Improved handling of empty result scenarios for better user experience with Markdown cards, ensuring they are hidden if no content is available.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2024

Walkthrough

Walkthrough

The updates to the HuiMarkdownCard in the Lovelace UI of Home Assistant enhance visibility management by introducing a new optional configuration property, show_empty. This allows the card to automatically hide when there is no content and show_empty is set to false. Additionally, an import of fireEvent is included to effectively manage events related to visibility changes.

Changes

File Path Change Summary
src/panels/lovelace/cards/hui-markdown-card.ts Added a conditional block to manage card visibility based on _templateResult.result and _config.show_empty. Included an import of fireEvent to facilitate visibility notifications.
src/panels/lovelace/cards/types.ts Introduced a new optional property show_empty?: boolean to the MarkdownCardConfig interface, enhancing configuration options for Markdown cards.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 409c64f and af5f394.

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

12-12: Import statement looks good.

The fireEvent import is necessary for managing visibility changes.


117-125: Visibility management logic looks good.

The logic efficiently toggles the visibility of the card based on the _templateResult.result and _config.show_empty properties.


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 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
src/panels/lovelace/cards/hui-markdown-card.ts (1)

116-123: fireEvent function is not imported.

The fireEvent function is not imported in src/panels/lovelace/cards/hui-markdown-card.ts. Ensure that the fireEvent function is imported at the top of the file to make it available in the scope.

  • File: src/panels/lovelace/cards/hui-markdown-card.ts
  • Lines: 116-123
Analysis chain

Verify the availability of fireEvent.

Ensure that the fireEvent function is imported or available in the scope for it to work correctly.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify if the `fireEvent` function is imported or available in the scope.

# Test: Search for the import statement or declaration of `fireEvent`. Expect: At least one occurrence.
rg --type typescript -A 2 $'import { fireEvent }'

Length of output: 162


Script:

#!/bin/bash
# Description: Verify if the `fireEvent` function is imported or available in the scope.

# Test: Search for the import statement or declaration of `fireEvent`. Expect: At least one occurrence.
rg --type typescript 'import { fireEvent }' -A 2

Length of output: 162


Script:

#!/bin/bash
# Description: Verify if the `fireEvent` function is imported or available in the scope.

# Test: Search for the import statement or declaration of `fireEvent`. Expect: At least one occurrence.
rg --type typescript "import { fireEvent }" -A 2

Length of output: 162


Script:

#!/bin/bash
# Description: Verify if the `fireEvent` function is imported or available in the scope.

# Test: Search for the import statement or declaration of `fireEvent`. Expect: At least one occurrence.
rg 'import { fireEvent }' --type typescript -A 2

Length of output: 162


Script:

#!/bin/bash
# Description: Verify if the `fireEvent` function is imported or available in the scope.

# Test: Search for the import statement or declaration of `fireEvent`. Expect: At least one occurrence.
grep -r 'import { fireEvent }' --include \*.ts

Length of output: 71499

@illuzn
Copy link
Contributor Author

illuzn commented Jul 12, 2024

@coderabbitai review

@illuzn
Copy link
Contributor Author

illuzn commented Jul 15, 2024

Linting error arises from hui-markdown-card.ts#L92:
https://github.com/illuzn/frontend/blob/5dd82ca74537b93b2ff68cb73b986dadc5b44fcf/src/panels/lovelace/cards/hui-markdown-card.ts#L89-L95
Type 'string' is not assignable to '"error" | "info" | "warning" | "success"'

I did not make this change but it seems to be a typing error.

@silamon
Copy link
Contributor

silamon commented Jul 15, 2024

Linting error arises from hui-markdown-card.ts#L92: https://github.com/illuzn/frontend/blob/5dd82ca74537b93b2ff68cb73b986dadc5b44fcf/src/panels/lovelace/cards/hui-markdown-card.ts#L89-L95 Type 'string' is not assignable to '"error" | "info" | "warning" | "success"'

I did not make this change but it seems to be a typing error.

It's a warning which can be ignored and not introduced in your PR.
Just run prettier (yarn run format:prettier) to get the CI green.

@@ -113,7 +114,18 @@ export class HuiMarkdownCard extends LitElement implements LovelaceCard {
if (changedProps.has("_config")) {
this._tryConnect();
}

if (
Copy link
Member

Choose a reason for hiding this comment

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

We should check if _templateResult or _config changed first

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

src/panels/lovelace/cards/hui-markdown-card.ts Outdated Show resolved Hide resolved
@bramkragten bramkragten enabled auto-merge (squash) July 31, 2024 08:46
@bramkragten bramkragten merged commit dbd8490 into home-assistant:dev Jul 31, 2024
13 checks passed
@illuzn illuzn deleted the markdown_show_empty_patch branch August 1, 2024 01:55
sairon added a commit that referenced this pull request Dec 3, 2024
The implementation of show_empty property in #21379 introduced
regression which causes Markdown cards rendered within a Grid card to
not take full height of its space. This is because a visible card is now
forced to have "display: block", while without that it's rendered as
"display: inline".

As the CSSStyleDeclaration.style mandates string type, it's not possible
to delete or null the value. Setting it to an empty string seems to do
the trick as well and the linter is happy too.

Fixes #23119
piitaya pushed a commit that referenced this pull request Dec 3, 2024
The implementation of show_empty property in #21379 introduced
regression which causes Markdown cards rendered within a Grid card to
not take full height of its space. This is because a visible card is now
forced to have "display: block", while without that it's rendered as
"display: inline".

As the CSSStyleDeclaration.style mandates string type, it's not possible
to delete or null the value. Setting it to an empty string seems to do
the trick as well and the linter is happy too.

Fixes #23119
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.

3 participants