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

Allow options flow to define form title/description #4598

Merged
merged 2 commits into from
Jan 25, 2020

Conversation

balloob
Copy link
Member

@balloob balloob commented Jan 25, 2020

Breaking change

Proposed change

Allow option flows to optionally define a title for the page that is being shown.

Issue home-assistant/core#30894 (comment)

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:
  • 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:

hass.localize(
`component.${step.handler}.options.step.${step.step_id}.title`
) || hass.localize(`ui.dialogs.options_flow.form.header`)
);
},

renderShowFormStepDescription(_hass, _step) {

Choose a reason for hiding this comment

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

Should we support description as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point. Done.

@balloob balloob changed the title Allow options flow to define their own title Allow options flow to define form title/description Jan 25, 2020
@bramkragten bramkragten merged commit f95ba4c into dev Jan 25, 2020
@delete-merged-branch delete-merged-branch bot deleted the allow-option-flow-titles branch January 25, 2020 13:39
@lock lock bot locked and limited conversation to collaborators Jan 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants