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

Fix visibility for shown entities on device card #22579

Conversation

ildar170975
Copy link
Contributor

#22577 must be merged first since it fixes a disabled entity row's height.

Breaking change

Proposed change

Currently if a device card contains only disabled entities, it causes a big vertical gap between a header & 1st disabled entity:
image

This PR:

  1. Adds a #entities element only if some enabled entities present.
  2. Decreases a top margin for a list of disabled entities.

After the fix (note that changes in #22577 here accounted - a fixed row's height = 40px):
image

If some entities are enabled:
image

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

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:

Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

@wendevlin wendevlin self-requested a review October 29, 2024 09:13
Copy link
Contributor

@wendevlin wendevlin left a comment

Choose a reason for hiding this comment

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

Thanks for the fix 🎉

There is still too much space when you have just the button +x entities.

What about refectoring it a bit?

3 wrapper:

  • shownEntities
  • seperator (only visible if shown + hidden length > 0
  • hiddenEntities

then you just have to add lit condition instead of css magic.

@home-assistant
Copy link

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.

@home-assistant home-assistant bot marked this pull request as draft October 29, 2024 09:28
@piitaya

This comment was marked as resolved.

ildar170975 and others added 2 commits October 29, 2024 14:55
…d.ts

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>
@ildar170975
Copy link
Contributor Author

ildar170975 commented Oct 29, 2024

3 wrapper:

* shownEntities

* seperator (only visible if shown + hidden length > 0

* hiddenEntities

Hi @wendevlin , thanks for reviewing.
Could you explain since I am a beginner.
Currently the cards contains:
-- mwc-list inside div#entiites
-- vertical space implemented by margin-top
-- mwc-list

Is adding a separator line between 2 mwc-lists is sufficient? (ofc along with required margins)
Kind of

  #entities + mwc-list:has(.disabled-entry) {
    border-top: 1px solid var(--divider-color, #e8e8e8);

@wendevlin
Copy link
Contributor

Hi @wendevlin , thanks for reviewing. Could you explain since I am a beginner. Currently the cards contains: -- mwc-list inside div#entiites -- vertical space implemented by margin-top -- mwc-list

Is adding a separator line between 2 mwc-lists is sufficient? (ofc along with required margins) Kind of

  #entities + mwc-list:has(.disabled-entry) {
    border-top: 1px solid var(--divider-color, #e8e8e8);

No as separator I just meant a div element with a specified height, which replaces the margin top and you can hide /show it via lit like:

${shownEntities.length && hiddenEntities.length ? html`<div class="entities-separator"></div>` : nothing}

So you don't have to set a margin for the button and the list, just show it or hide it.

@ildar170975
Copy link
Contributor Author

@wendevlin
Tried this suggestion and was disappointed.
Assume I added a conditional div:

      .entities-separator {
        height: 8px;
      }

instead of

      #entities + mwc-list:has(.disabled-entry) {
        margin-top: 8px;
      }

So, now a space between div#entities & mwc-list = 8px.
But if div#entities is not shown, I anyway have to move mwc-list up:

      mwc-list:has(.disabled-entry) {
        margin-top: -8px; /* and some pseudoclass should be specified to apply this style only when div#entities is not shown */
      }

So, introducing a conditional .entities-separator does not reduce amount of styles drastically (
What do you think?

Copy link
Contributor

@wendevlin wendevlin left a comment

Choose a reason for hiding this comment

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

Hey @ildar170975,

Ok let's do it like this:

wrap the hiddenEntities into a div and give it a class only if shownEntities are not there:

${hiddenEntities.length
          ? html`<div class=${classMap({ "move-up": !shownEntities.length })}>
              ${!this.showHidden
                ? html`
                    <button class="show-more" @click=${this._toggleShowHidden}>
                      ${this.hass.localize(
                        "ui.panel.config.devices.entities.hidden_entities",
                        { count: hiddenEntities.length }
                      )}
                    </button>
                  `
                : html`
                    <mwc-list>
                      ${hiddenEntities.map((entry) => this._renderEntry(entry))}
                    </mwc-list>
                    <button class="show-more" @click=${this._toggleShowHidden}>
                      ${this.hass.localize(
                        "ui.panel.config.devices.entities.show_less"
                      )}
                    </button>
                  `}
            </div>`
          : nothing}

and replace #entities margin-top with:

      .move-up {
        margin-top: -24px;
      }

ildar170975 and others added 3 commits October 30, 2024 19:00
…d.ts

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>
…d.ts

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>
@ildar170975
Copy link
Contributor Author

ildar170975 commented Oct 30, 2024

@wendevlin
I like this proposal. Now it looks better, w/o a space between shown & disabled entities:
image
Thanks a lot for support & patience!

@ildar170975 ildar170975 marked this pull request as ready for review October 30, 2024 16:20
@home-assistant home-assistant bot marked this pull request as draft October 31, 2024 12:42
@ildar170975 ildar170975 marked this pull request as ready for review October 31, 2024 14:05
wendevlin
wendevlin previously approved these changes Nov 7, 2024
wendevlin
wendevlin previously approved these changes Nov 7, 2024
@wendevlin
Copy link
Contributor

@ildar170975 Sorry I was a bit busy, thank you for your improvement 🎉

@wendevlin wendevlin enabled auto-merge (squash) November 7, 2024 19:08
@wendevlin
Copy link
Contributor

@ildar170975 unfortunately the CI failed, you will need to run yarn run lint:prettier and commit the changes.

@ildar170975
Copy link
Contributor Author

@wendevlin
I am away from PC these days, hope will come back next week and proceed.
Thank you very very much for support and patience.

auto-merge was automatically disabled November 13, 2024 00:47

Head branch was pushed to by a user without write access

@ildar170975
Copy link
Contributor Author

@wendevlin
Is it OK now?

@wendevlin wendevlin merged commit 3c6be8c into home-assistant:dev Nov 13, 2024
18 of 22 checks passed
@ildar170975 ildar170975 deleted the fix_visibility_for_shown_entities_on_device_card branch November 13, 2024 06:58
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