Skip to content

Commit

Permalink
Add fonts property to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raub committed Jan 15, 2025
1 parent 9a3d0f7 commit 76e699c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ fonts and provides low-level interface:
FontAwesome.icons: { [name]: string } // icon name -> unicode character
FontAwesome.list: string[] // list of all icon names, same as `Object.keys(FontAwesome.icons)`
FontAwesome.listUnique: string[] // list of unique icon names, excluding aliases
FontAwesome.fonts: { // auxilary font descriptions
regular: { family: string, weight: number },
solid: { family: string, weight: number },
brands: { family: string, weight: number },
}
FontAwesome.getFamily: (name) => string // one of Font Awesome font names
FontAwesome.getWeight: (name) => number // 400 or 900 (`Font.Normal` or `Font.Black`)
FontAwesome.getText: (name) => string // icon unicode, sane as `FontAwesome.icons[name]`
Expand Down

0 comments on commit 76e699c

Please sign in to comment.