Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add icon reference to Lovelace documentation #16865

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 15, 2021
Merged

Add icon reference to Lovelace documentation #16865

merged 2 commits into from
Mar 15, 2021

Conversation

frenck
Copy link
Member

@frenck frenck commented Mar 5, 2021

Proposed change

Add some information on which icons one can use to the Lovelace documentation.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes Link to icon documentation #16860

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@probot-home-assistant probot-home-assistant bot added the current This PR goes into the current branch label Mar 5, 2021
@frenck frenck merged commit 57acb25 into current Mar 15, 2021
@frenck frenck deleted the frenck-2021-0787 branch March 15, 2021 12:58
ludeeus
ludeeus approved these changes Mar 15, 2021
View reviewed changes
Copy link
Member

@ludeeus ludeeus left a comment

Choose a reason for hiding this comment

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

The statement "You can use any icon from MaterialDesignIcons.com" is technically not correct, you can only use icons that are in the version of MDI we use in the version of Core you are running, so it will be icons on MaterialDesignIcons that can not be used

source/lovelace/badges.markdown
@@ -30,7 +30,7 @@ name:
default: Name of entity
icon:
required: false
description: Overwrites icon or entity picture.
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.

URL should be lowercase

source/lovelace/badges.markdown
@@ -87,7 +87,7 @@ name:
type: string
icon:
required: false
description: Overwrites icon or entity picture.
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.

URL should be lowercase

source/lovelace/dashboards-and-views.markdown
@@ -110,7 +110,7 @@ dashboards:
type: string
icon:
required: false
description: The icon to show in the sidebar.
description: The icon to show in the sidebar. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: The icon to show in the sidebar. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
description: The icon to show in the sidebar. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.

URL should be lowercase

source/lovelace/dashboards-and-views.markdown
@@ -227,7 +227,7 @@ views:
default: view index
icon:
required: false
description: Icon-name from Material Design Icons.
description: Icon-name from Material Design Icons. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: Icon-name from Material Design Icons. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
description: Icon-name from Material Design Icons. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.

URL should be lowercase

source/lovelace/header-footer.markdown
@@ -69,7 +69,7 @@ entities:
type: string
icon:
required: false
description: Override the entity icon.
description: Override the entity icon. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: Override the entity icon. You can use any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
description: Override the entity icon. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.

URL should be lowercase

@frenck
Copy link
Member Author

frenck commented Mar 15, 2021

The statement "You can use any icon from MaterialDesignIcons.com" is technically not correct, you can only use icons that are in the version of MDI we use in the version of Core you are running, so it will be icons on MaterialDesignIcons that can not be used

True, but generally... it will be fine (as we have no other way to reference do it). Unless... we build a icon picker in the frontend of course 😉

Comments addressed in #17012

@ludeeus
Copy link
Member

ludeeus commented Mar 15, 2021

We could probably get the MDI version of the package.json in the frontend repo somehow and use that :D but that will require more work than what it's worth for those few cases.

@github-actions github-actions bot locked and limited conversation to collaborators Mar 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ludeeus ludeeus ludeeus approved these changes

@pvizeli pvizeli pvizeli approved these changes

Assignees
No one assigned
Labels
cla-signed current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Link to icon documentation
4 participants
@frenck @ludeeus @pvizeli @homeassistant