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

Use grid options instead of layout options #2440

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Use grid options instead of layout options #2440

merged 2 commits into from
Mar 12, 2025

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Nov 5, 2024

Proposed change

Grid options is replacing layout options in 2024.11

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Updated the custom card documentation to reflect changes in naming and structure of layout options.
    • Renamed getLayoutOptions to getGridOptions and updated its return structure for clarity.
    • Increased default columns from 2 to 6, emphasizing multiples of 3 for better visual alignment.
    • Clarified grid cell dimensions based on section width divided by 12.
    • Adjusted example implementations to align with the new grid system.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

📝 Walkthrough

Walkthrough

The documentation for the custom card in Home Assistant has been updated to reflect changes in terminology and structure regarding layout options. The method getLayoutOptions is now called getGridOptions, with corresponding updates to its return structure and keys. The default number of columns has increased, and new grid options have been introduced to enhance card sizing flexibility. The documentation also clarifies the calculation of grid cell dimensions and updates example implementations to align with these changes.

Changes

File Path Change Summary
docs/frontend/custom-ui/custom-card.md Renamed getLayoutOptions to getGridOptions. Updated return keys and default column number. Clarified grid cell dimensions and adjusted example implementations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CustomCard
    participant GridOptions

    User->>CustomCard: Request layout options
    CustomCard->>GridOptions: Call getGridOptions()
    GridOptions-->>CustomCard: Return updated grid options
    CustomCard-->>User: Display card with new grid layout
Loading

🪧 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 generate docstrings to generate docstrings for this 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.

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 and nitpick comments (3)
docs/frontend/custom-ui/custom-card.md (3)

55-62: Consider making row configuration more flexible.

The current implementation sets rows, min_rows, and max_rows all to 3, which effectively locks the card height. Consider allowing more flexibility by either:

  1. Removing min_rows and max_rows to allow dynamic resizing, or
  2. Setting different values for min/max to provide a range.
  getGridOptions() {
    return {
      rows: 3,
      columns: 6,
-     min_rows: 3,
-     max_rows: 3,
+     min_rows: 2,    // Allow slightly smaller
+     max_rows: 4,    // Allow slightly larger
    };
  }

118-126: Fix formatting of grid options list.

The list formatting needs improvement for better readability.

 The different grid options are:
-
-- `rows`: Default number of rows the card takes
-- `min_rows`: Minimal number of rows the card takes
-- `max_rows`: Maximal number of rows the card takes
-- `columns`: Default number of columns the card takes (set it to `full` to enforce your card to be full width)
-- `min_columns`: Minimal number of columns the card takes
-- `max_columns`: Maximal number of columns the card takes
+
+ - `rows`: Default number of rows the card takes
+ - `min_rows`: Minimal number of rows the card takes
+ - `max_rows`: Maximal number of rows the card takes
+ - `columns`: Default number of columns the card takes (set it to `full` to enforce your card to be full width)
+ - `min_columns`: Minimal number of columns the card takes
+ - `max_columns`: Maximal number of columns the card takes
🧰 Tools
🪛 LanguageTool

[uncategorized] ~120-~120: Loose punctuation mark.
Context: ...he different grid options are: - rows: Default number of rows the card takes -...

(UNLIKELY_OPENING_PUNCTUATION)


132-141: Consider enhancing the example implementation.

While the current example is good, it could be more comprehensive by:

  1. Demonstrating the recommended column values (multiples of 3)
  2. Showing how to use min_columns and max_columns
  3. Including the full width option mentioned in the documentation
 public getGridOptions() {
   return {
     rows: 2,
-    columns: 6,
+    columns: 6,      // Multiple of 3 for better alignment
     min_rows: 2,
+    min_columns: 3,  // Example of column constraints
+    max_columns: 9,
   };
 }

Add another example demonstrating full-width usage:

// Example of full-width card
public getGridOptions() {
  return {
    rows: 1,
    columns: "full",  // Forces card to full width
    min_rows: 1,
    max_rows: 2,
  };
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6295807 and c5439a8.

📒 Files selected for processing (1)
  • docs/frontend/custom-ui/custom-card.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/frontend/custom-ui/custom-card.md

[uncategorized] ~120-~120: Loose punctuation mark.
Context: ...he different grid options are: - rows: Default number of rows the card takes -...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (2)
docs/frontend/custom-ui/custom-card.md (2)

109-110: LGTM! Clear introduction to grid options.

The documentation clearly explains the purpose and context of the grid options method.


114-116: LGTM! Well-defined cell dimensions.

The cell dimensions are clearly specified with exact measurements.

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

🧹 Nitpick comments (3)
docs/frontend/custom-ui/custom-card.md (3)

55-61: Verify Updated getGridOptions() Implementation
The updated getGridOptions() method now returns the keys rows, columns, min_rows, and max_rows with the new default (columns: 6). Consider whether additional keys such as min_columns and max_columns should be included to fully document the new grid options. If these keys are optional, a brief note could help clarify the intended usage.

 getGridOptions() {
   return {
-    rows: 3,
-    columns: 6,
-    min_rows: 3,
-    max_rows: 3,
+    rows: 3,
+    columns: 6,
+    min_rows: 3,
+    max_rows: 3,
+    // Optionally add:
+    // min_columns: <default_value>,
+    // max_columns: <default_value or undefined>,
   };
 }

109-110: Refine Preposition in Grid Option Description
In the explanatory text describing grid behavior, consider changing the phrase "take in the grid" to "take into the grid" for improved clarity and consistency with standard English usage.

-You can define a `getGridOptions` method that returns the min, max and default number of cells your card will take in the grid if your card is used in the [sections view](https://www.home-assistant.io/dashboards/sections/).
+You can define a `getGridOptions` method that returns the min, max, and default number of cells your card will take into the grid if your card is used in the [sections view](https://www.home-assistant.io/dashboards/sections/).
🧰 Tools
🪛 LanguageTool

[uncategorized] ~109-~109: The preposition “into” seems more likely in this position than the preposition “in”.
Context: ...rds/sections/). Each section is divided in 12 columns. If you don't define this me...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_INTO)


126-127: Improve Grammar in Grid Options List
For the recommendation on column defaults, consider adjusting the phrasing to include the missing article and improve readability. For example, change "use multiple of 3" to "use a multiple of 3" and rephrase the ending to enhance clarity.

-For the number of columns, it's `highly` recommended to use multiple of 3 for the default value (`3`, `6`, `9` or `12`) so your card will have better looking on the dashboard by default.
+For the number of columns, it's highly recommended to use a multiple of 3 for the default value (e.g., `3`, `6`, `9`, or `12`) so that your card displays better on the dashboard by default.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~127-~127: You might be missing the article “a” here.
Context: ...lumns, it's highly recommended to use multiple of 3 for the default value (3, 6, `...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5439a8 and b027a8f.

📒 Files selected for processing (1)
  • docs/frontend/custom-ui/custom-card.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/frontend/custom-ui/custom-card.md

[uncategorized] ~109-~109: The preposition “into” seems more likely in this position than the preposition “in”.
Context: ...rds/sections/). Each section is divided in 12 columns. If you don't define this me...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_INTO)


[uncategorized] ~120-~120: Loose punctuation mark.
Context: ...he different grid options are: - rows: Default number of rows the card takes. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~127-~127: You might be missing the article “a” here.
Context: ...lumns, it's highly recommended to use multiple of 3 for the default value (3, 6, `...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

🔇 Additional comments (1)
docs/frontend/custom-ui/custom-card.md (1)

132-138: Example Implementation Clarity
The provided example for the getGridOptions() method correctly demonstrates the new method signature and default grid sizing. This example is clear and consistent with the prior implementation.

@wendevlin wendevlin merged commit 4479af8 into master Mar 12, 2025
5 checks passed
@wendevlin wendevlin deleted the grid_layout branch March 12, 2025 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants