@geira/iconfont
v4.0.0
Published
Geira Icon Font
Readme
Geira Icons
A clean, ligature-based icon font for web and Flutter.
Browse all icons at icons.geira.com.
Installation
npm install @geira/iconfontUsage
CSS
Add the stylesheet inside your HTML <head>:
<link rel="stylesheet" href="node_modules/@geira/iconfont/dist/geira-icons.css">SCSS
@use '@geira/iconfont/dist/geira-icons';Class-based (recommended)
<span class="geira-icons gi-pencil"></span>Ligature-based
<span class="geira-icons">pencil</span>Size modifiers
<span class="geira-icons gi-pencil gi-18"></span>
<span class="geira-icons gi-pencil gi-24"></span>
<span class="geira-icons gi-pencil gi-36"></span>
<span class="geira-icons gi-pencil gi-48"></span>Color modifiers
<span class="geira-icons gi-pencil gi-dark"></span>
<span class="geira-icons gi-pencil gi-dark gi-inactive"></span>
<span class="geira-icons gi-pencil gi-light"></span>Transform modifiers
<span class="geira-icons gi-pencil gi-rotate-90"></span>
<span class="geira-icons gi-pencil gi-flip-h"></span>
<span class="geira-icons gi-wifi gi-spin"></span>Flutter
flutter pub add geira_iconsSee the pub.dev package for Flutter usage details.
Development
Setup
git clone https://github.com/liontude/geira-icons-tool
cd geira-icons-tool
npm install
cp .env.example .env # fill in SFTP credentialsBuild
npm run buildReads src/fonts/GeiraIcons-Regular.ttf, syncs tags.json, and writes everything to dist/.
Dev server
npm run devOpens http://localhost:3000. Rebuilds automatically when the font or tags.json changes.
Updating the font
- Export from FontLab → TTF + WOFF2 + WOFF
- Replace the three files in
src/fonts/ npm run build
If the build warns about icons with empty tags, edit tags.json and run npm run build again.
Improving search tags
Edit tags.json, then npm run build.
Releasing
npm run release:patch # 0.3.3 → 0.3.4
npm run release:minor # 0.3.3 → 0.4.0
npm run release:major # 0.3.3 → 1.0.0Each command bumps the version, builds, publishes to npm, and deploys the demo to icons.geira.com. After that, push the version commit and tag:
git push && git push --tagsLicense
The MIT License (MIT)
Copyright (c) Liontude, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
