Support for disabled selectors in config flow #22592

karwosts · 2024-10-29T22:39:44Z

Proposed change

Support for Support readonly selectors in config_flows core#129456

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

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion:
Link to documentation pull request:

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:

Documentation added/updated for www.home-assistant.io

coderabbitai · 2024-10-29T22:39:52Z

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.

src/components/ha-form/types.ts

balloob · 2024-11-01T19:06:05Z

src/components/ha-form/types.ts

@@ -25,6 +25,8 @@ export interface HaFormBaseSchema {
    suffix?: string;
    // This value will be set initially when form is loaded
    suggested_value?: HaFormData;
+    // Readonly flag is passed here from backend for config flow
+    readonly?: boolean;


nitpick: isn't read only 2 words? And so it should be read_only and readOnly

You're technically correct. readonly is pretty established in frontend libraries though. We won't use it directly and convert it to disabled so whatever core decides as long as it isn't disabled

https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/r/read-only gives read-only which seems to also be in the dictionaries.
We should probably change to read_only which translates to read-only

I can change the var to read_only, but I'm confused by what you mean by "translates to read-only"

I meant for end users it should say "read-only".
I didn't look at the frontend PR really but is there a tooltip or something for the end-users to understand these are read-only on purpose?

As far as I know there is not a tooltip.

Maybe custom description strings could be used for the options flow fields if desired, right now they are reusing the description strings from the config flow.

I thought another enhancement could be to stick these fields in an expansion panel with a description of why they are there, but reading how config/options flow is handled in history stats I couldn't yet figure out how to make that work, so punting on that for now.

Maybe custom description strings could be used for the options flow fields if desired, right now they are reusing the description strings from the config flow.

Probably the best way to handle it right now.

I thought another enhancement could be to stick these fields in an expansion panel with a description of why they are there, but reading how config/options flow is handled in history stats I couldn't yet figure out how to make that work, so punting on that for now.

Probably a section with a description would be quite nice. But sections are not really built in that way to only be used in the options flow as it's saving the data with the section.

… disabled-fields-config-flow

Support for disabled selectors in config flow

b833040

home-assistant bot added cla-signed hacktoberfest labels Oct 29, 2024

karwosts mentioned this pull request Oct 29, 2024

Support readonly selectors in config_flows home-assistant/core#129456

Open

19 tasks

MindFreeze reviewed Oct 30, 2024

View reviewed changes

src/components/ha-form/types.ts Outdated Show resolved Hide resolved

bramkragten added the wait for backend label Oct 30, 2024

rename flag to readonly

e8d7271

MindFreeze previously approved these changes Oct 30, 2024

View reviewed changes

balloob reviewed Nov 1, 2024

View reviewed changes

karwosts added 2 commits November 23, 2024 05:54

Merge branch 'dev' of https://github.com/home-assistant/frontend into…

a5e4369

… disabled-fields-config-flow

rename to read_only

e843c42

karwosts dismissed MindFreeze’s stale review via e843c42 November 23, 2024 14:05

MindFreeze approved these changes Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for disabled selectors in config flow #22592

Support for disabled selectors in config flow #22592

karwosts commented Oct 29, 2024 •

edited by wendevlin

Loading

coderabbitai bot commented Oct 29, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

balloob Nov 1, 2024

MindFreeze Nov 23, 2024

gjohansson-ST Nov 23, 2024

karwosts Nov 23, 2024

gjohansson-ST Nov 23, 2024

karwosts Nov 23, 2024

gjohansson-ST Nov 23, 2024

Support for disabled selectors in config flow #22592

Are you sure you want to change the base?

Support for disabled selectors in config flow #22592

Conversation

karwosts commented Oct 29, 2024 • edited by wendevlin Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

coderabbitai bot commented Oct 29, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

balloob Nov 1, 2024

Choose a reason for hiding this comment

MindFreeze Nov 23, 2024

Choose a reason for hiding this comment

gjohansson-ST Nov 23, 2024

Choose a reason for hiding this comment

karwosts Nov 23, 2024

Choose a reason for hiding this comment

gjohansson-ST Nov 23, 2024

Choose a reason for hiding this comment

karwosts Nov 23, 2024

Choose a reason for hiding this comment

gjohansson-ST Nov 23, 2024

Choose a reason for hiding this comment

karwosts commented Oct 29, 2024 •

edited by wendevlin

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)