@odoro-cli/icons
v2.0.0
Published
Odoro icon module: several packs normalised on one contract, one export per icon so that tree shaking works.
Readme
@odoro-cli/icons
Five icon packs for Odoro, imported one at a time.
npm i @odoro-cli/iconsimport { Icon } from '@odoro-cli/icons'
import { ArrowRight, Sparkles } from '@odoro-cli/icons/outline'
;<Icon of={ArrowRight} className="o-size-5" />The packs
| Entry point | Style | Count |
| --------------------------- | ------------- | ----: |
| @odoro-cli/icons/outline | Outline | 2048 |
| @odoro-cli/icons/compact | Compact solid | 2078 |
| @odoro-cli/icons/classic | Classic | 2001 |
| @odoro-cli/icons/extended | Extended | 3903 |
| @odoro-cli/icons/brands | Brand marks | 609 |
@odoro-cli/icons/catalogue.json lists every name, if you need to build a
picker.
You ship what you import
Each icon is a separate export, so a bundler keeps only the ones your code names. Importing from a pack does not pull the pack in.
That is also why the packs are separate entry points rather than one big index: a single barrel would make every icon reachable from one import, and tree-shaking would have far more work to prove what can go.
Colour and size come from the outside
Icons are drawn with currentColor and sized by their container. They take the
colour of the text around them, in light and dark alike, with nothing to
configure.
<span className="o-text-brand-500">
<Icon of={Sparkles} className="o-size-6" />
</span>Links
- Documentation — https://odoro.dev/docs
- Source — https://github.com/ODORO-CLI/OdoroKit
Licence
UNLICENSED. Copyright (c) BouBouw. See LICENSE. Icon sources and their own
licences are listed in CREDITS.md at the root of the repository.
