Giter VIP home page Giter VIP logo

hass-fontawesome's Introduction

hass-fontawesome

hacs_badge

Use free icons from the fontawesome set in Home-assistant.

Installation instructions

  • Install using HACS (Or copy the contents of custom_components/fontawesome/ to <your config dir>/custom_components/fontawesome/.)

  • Restart Home Assistant

  • Go to your integrations configuration and add FontAwesome Install

  • Open the settings for the new FontAwesome integration

  • Click the Options gear (red arrow below) and select which icon sets to load Options

Icon sets

The icons are divided into three sets.

  • Solid
  • Regular
  • Brands

Each set will add a few hundred kilobytes to the ammount of data that's downloaded to your browser every time you open up your Home Assistant interface, so to save on your data plan, make sure to only select the ones you actually need.

Usage

Find the icon you want in the gallery.

The three icon sets have different prefixes: fas:, far: and fab: respectively.

So,

  • to get a solid heart, use fas:heart
  • to get a heart outline, use far:heart
  • to get the twitter symbol, use fab:twitter

The icons are useable anywhere in Home Assistant - not only in lovelace.

FAQ

Can I use this with my Pro icon set?

Yes you can, but you'll need to build things yourself.

  1. Get your personal token first.

Go to https://fontawesome.com/how-to-use/on-the-web/setup/using-package-managers and find your token. The command will look like this:

$ npm config set "@fortawesome:registry" https://npm.fontawesome.com/ && \
  npm config set "//npm.fontawesome.com/:_authToken" XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
  1. Clone this repository and modify it to build with the fontawesome-pro icons. This will also build the duotone and light series.
$ git clone https://github.com/thomasloven/hass-fontawesome
$ cd hass-fontawesome/
$ git apply < fontawesome-pro.patch
$ npm install && npm run-script build

Note that the duotone serie doesn't seem to work correctly yet in Home Assistant, since all colors are mapped to one color.

  1. Copy the output of custom_components/fontawesome/ to you Home Assistant installation.

Can I set this up in configure.yaml instead?

Yes.

fontawesome:
  regular:
  solid:
  brands:

Just remove the lines for the icon sets you don't want.


Buy Me A Coffee

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.