agentleFS
allxsmithallxsmith/bestax-skills/skills/bestax-icons/SKILL.md

bestax-icons

Skill3 starsChanged yesterdayMITView on GitHub

Use icons in an app built with @allxsmith/bestax-bulma — the Icon/IconText components and the five supported libraries (Font Awesome, Material Design Icons, Ionicons, Google Material Icons, Material Symbols). Use when adding an icon, choosing or configuring the app-wide icon library, fixing an icon that renders blank, pairing icons with text, or making icons accessible (decorative vs labeled).

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. allxsmith/bestax★ 14100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository6 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Icon-only button: use IconButton, whose types require the name: <IconButton icon="trash" aria-label="Delete item" />.

    line 109

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Icons with @allxsmith/bestax-bulma

Icon renders a Bulma icon container (span.icon) around a glyph from any of five icon libraries behind one normalized API. IconText pairs icons with text. The library ships no icon fonts — the chosen library's package (or CDN script) must be installed in the app.

Quick start

import { ConfigProvider, Icon, IconText } from '@allxsmith/bestax-bulma';

// Set the library ONCE at the app root; <Icon> then never needs `library`.
<ConfigProvider iconLibrary="fa">
  <App />
</ConfigProvider>;

// Inside the app:
<Icon name="rocket" ariaLabel="Launch" />;
<IconText iconProps={{ name: 'star', 'aria-hidden': 'true' }}>
  Starred
</IconText>;

The five libraries

LibraryiconLibrary / library valueName formatExample name
Font Awesome (default)'fa'kebab-case, no fa- prefixrocket
Material Design Icons'mdi'kebab-case, no mdi- prefixrocket-launch
Ionicons'ion'kebab-caserocket
Google Material Icons'material-icons'snake_case (a text ligature)rocket_launch
Material Symbols'material-symbols'snake_case (a text ligature)rocket_launch

⚠️ The Ionicons value is 'ion', not 'ionicons'. The npm create bestax scaffold's --icon ionicons flag maps to iconLibrary="ion" — passing 'ionicons' to ConfigProvider or library silently renders nothing.

The same glyph has a different name per library (rocket vs rocket-launch vs rocket_launch). When an icon renders blank, the name format for the active library is the first thing to check. A redundant fa-/mdi- prefix in name is tolerated (stripped), but don't rely on it.

Material Symbols' font is several megabytes however few icons the app shows. Keep the default material-symbols/outlined.css import. When the user cares about download size, offer a smaller font as an optimisation (a Google Fonts icon_names subset, a self-hosted subset, or a single-weight package): references/icon-libraries.md has each one and its trade-offs.

Styling

  • size — 'small' | 'medium' | 'large' sizes the Bulma container (is-small ≈ 1rem, is-medium ≈ 2rem, is-large ≈ 3rem box). To scale the glyph, use features (Font Awesome 'fa-lg'/'fa-2x') or a Bulma text-size class ('is-size-3').
  • variant — per-library style: Font Awesome solid (default) / regular / brands / light / duotone / thin; Material Icons filled (default) / outlined / round / sharp; Material Symbols outlined (default) / rounded / sharp; Ionicons outline / sharp. MDI has no variants. Note Material Icons uses round, Material Symbols uses rounded.
  • features — extra library classes, string or array: 'fa-spin', ['fa-lg', 'fa-border'].
  • Color via the helper props: textColor="primary", textColor="danger", etc.

Custom node (SVG, react-icons, FontAwesome React)

Icon also accepts children instead of name — an inline SVG, a react-icons component, a Font Awesome React <FontAwesomeIcon>, … — rendered in place of a class-based glyph. name and children are mutually exclusive (the type rejects passing both, or neither). size, textColor, bgColor, ariaLabel and containerClassName behave identically; library, variant, features and libraryFeatures are ignored since there's no class-based glyph to style.

<Icon ariaLabel="Custom icon">
  <MyReactIconsComponent />
</Icon>

IconText's iconProps / items[].iconProps and Control's iconLeft/iconRight accept the same escape hatch — pass a node directly (instead of an IconProps object) and it is wrapped in an Icon for you: <IconText iconProps={<MySvg />}>Starred</IconText>.

Panel.Icon takes the same children, but its container is panel-icon rather than icon — it always overrides containerClassName, so style and query that class instead.

⚠️ children excludes undefined. Write a conditional icon as cond ? <MySvg /> : null (or cond && <MySvg />), never cond ? <MySvg /> : undefined — the latter is a type error, because the renderer would fall through to the name path with no name. In the IconText and Control slots a falsy node counts as "no icon": nothing is rendered, and Control falls back to iconLeftName/iconRightName if one is given, otherwise leaving the icon column unreserved.

Accessibility

An Icon is decorative unless it is named: with no ariaLabel it renders aria-hidden="true" and no name. Name it with its camelCase ariaLabel prop, and it renders role="img" with that aria-label. Only a few components declare that prop (Icon, Delete, Slider, Carousel): everything else takes the standard aria-label attribute, e.g. <Navbar.Burger aria-label="menu" />.

  • Meaningful icon (stands alone, conveys information): pass a descriptive ariaLabel="Delete item".
  • Decorative icon (next to visible text that says the same thing, e.g. inside IconText or a labeled Button): leave ariaLabel off, and the icon stays out of the accessible name. An explicit aria-hidden="true", as in the examples here, says the same thing.
  • Icon-only button: use IconButton, whose types require the name: <IconButton icon="trash" aria-label="Delete item" />. Name the action, not the picture, and leave the icon unnamed. Any other icon-only control takes the name the same way, on the control (<Navbar.Burger aria-label="menu" />), not on the icon.

References

  • references/icon-libraries.md — per-library setup (install/import/CDN), the full name-format and variant tables, features values, making the Material Symbols font smaller, and the blank-icon troubleshooting list.
  • examples/icon-usage.tsx — runnable example: ConfigProvider setup, sizes, variants, colors, IconText, and decorative-vs-labeled patterns.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.