https://github.com/menahishayan/homeassistant-cupertino-icons

Apple SF Symbols icons for Home Assistant! (3000+ icons)
https://github.com/menahishayan/homeassistant-cupertino-icons

apple cupertino-design cupertino-icons hacs home-assistant homeassistant icons ios sfsymbols ui

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/menahishayan/homeassistant-cupertino-icons
• Owner: menahishayan
• License: other
• Created: 2020-10-29T09:05:02.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-31T12:03:05.000Z (almost 2 years ago)
• Last Synced: 2024-10-23T08:53:04.308Z (2 months ago)
• Topics: apple, cupertino-design, cupertino-icons, hacs, home-assistant, homeassistant, icons, ios, sfsymbols, ui
• Language: JavaScript
• Homepage:
• Size: 5.33 MB
• Stars: 131
• Watchers: 11
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/hacs/integration)

# Home Assistant Cupertino Icons

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





     



     



     



     



     



     



  




     



     



     



     



     



     





## Install

### HACS (Recommended)

1. **HACS** tab > Menu > **Custom Repository**

4. Paste this repo's URL

5. Select **Integration** in the dropdown

6. Install **cupertino-icons** from HACS

7. Restart Home Assistant

8. 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

7. Restart Home Assistant

8. 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+)





     



     



     



     



     



     



  




     



     



     



     



     



     





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](https://github.com/thomasloven/hass-fontawesome) 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](https://developer.apple.com/sf-symbols/)  

[SF Symbols Reference | SFSymbols.com](https://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.