Skip to content

menahishayan/HomeAssistant-Cupertino-Icons

Repository files navigation

hacs_badge

Home Assistant Cupertino Icons

Apple SF Symbols Icons for Home Assistant! (3000+ Icons)

preview     preview     preview     preview     preview     preview     preview
preview     preview     preview     preview     preview     preview     preview

Install

HACS (Recommended)

  1. HACS tab > Menu > Custom Repository
  2. Paste this repo's URL
  3. Select Integration in the dropdown
  4. Install cupertino-icons from HACS
  5. Restart Home Assistant
  6. Home Assistant > Settings > Integrations > Add > Cupertino Icons > Install

The icons should be usable in Home Assistant now. If it doesnt show up, try refreshing the page, private browsing or restart Home Assistant.

Manual

  1. Copy custom_components/cupertino into your custom_components folder
  2. Restart Home Assistant
  3. Home Assistant > Settings > Integrations > Add > Cupertino Icons > Install

The icons should be usable in Home Assistant now. If it doesnt show up, try refreshing the page, private browsing or restart Home Assistant

Usage

Prefix: ios
Eg: ios:lightbulb-fill | ios:cloud-moon-rain | ios:bed-double-fill

Multi-Color Icons! (v3.0+)

preview     preview     preview     preview     preview     preview     preview
preview     preview     preview     preview     preview     preview     preview

SF Symbols 3+ supports multi-color icons. This functionality has been ported into this repo to support multi-color icons in Home Assistant!

Just add Suffixes #color, #invert, #color-invert or #fullcolor to change the icon colors! (Credit to thomasloven for the inspiration)

Eg:

  • ios:gear-badge-xmark#color
  • ios:gear-badge-xmark#color-invert
  • ios:gear-badge-xmark#fullcolor

Icon Reference

v3.0 Update

  • Home Assistant Cupertino Icons has now been updated to SF Symbols v3.0 with 3167 Icons! (Copyrighted icons excluded)
  • Supports Home Assistant's icon picker (2021.11.0+)

SF Symbols | Apple
SF Symbols Reference | SFSymbols.com

You may download the MacOS App from Apple for a better reference.

Note: underscores(_) and dots(.) must be swapped with hipens(-)

Breaking Changes

Starting with v3.0+, this repo has been changed from a lovelace/frontend repo to a full-fledged integration. If you're upgrading from an older version:

  1. HACS > Uninstall "cupertino-icons"
  2. HACS > Menu > Custom Repository
  3. Delete this repo
  4. Follow Install instructions above

Legal Disclaimer

Certain icons are copyrighted by Apple and are not allowed to used with modification. These icons have not been exported and are not present in this repo. They will not be included.


To Do

☑️ Upgrade to SF Pro Symbols v2.1
☑️ Upgrade to SF Pro Symbols v3.0
☑️ Multicolor support
☑️ Icon Picker

Changelog

v3.0.2

  • Fixed a bug that caused sizing issues

v3.0.1

  • Fixed a bug that caused multi-color icons to be displayed incorrectly

v3.0

  • Update to SF Symbols 3.0
  • Support for multicolor icons
  • Supports icon picker
  • Restructure and refactor layout
  • Breaking Changes: Repo type has been changed from frontend/lovelace plugin to a full-fledged integration. You may need to uninstall, delete the repo from HACS and reinstall.