Installation

npm install @thinkhuman/react-native-simple-icons react-native-svg

Usage

import { SiReact } from "@thinkhuman/react-native-simple-icons";

export function Example() {
  return <SiReact size={32} color="default" />;
}

import { SiGithub } from "@thinkhuman/react-native-simple-icons";

export function Example() {
  return <SiGithub size={24} color="#000" accessibilityLabel="GitHub" />;
}

Each icon exports its component and metadata:

import { SiReact, SiReactHex, SiReactSlug, SiReactTitle } from "@thinkhuman/react-native-simple-icons";

color="default" uses the brand color from simple-icons. The regular color default is "black" because React Native support for "currentColor" is not consistent across targets.

API

import type { SvgProps } from "react-native-svg";

export type IconProps = Omit<SvgProps, "color"> & {
  size?: number | string;
  color?: string | "default";
  title?: string;
};

Icons render with viewBox="0 0 24 24". Remaining props are passed to Svg.

Generation

Generate icons with:

bun run generate:icons

The generator imports all icon data from simple-icons, writes src/icons, writes src/index.ts, and records the processed version plus per-icon hashes in src/simple-icons-manifest.json.

Generated output is deterministic. Running the generator twice with the same simple-icons version should not change files.

Validation

Run the full local check with:

bun run validate

CI runs the generator, checks git diff --exit-code, then runs typecheck, tests, and build.

Versioning

The npm package version matches the processed simple-icons version (for example 16.19.0). bun run generate:icons updates package.json and src/simple-icons-manifest.json together, so icon updates and the publishable version stay aligned.

Updates

.github/workflows/update-icons.yml runs every 3 days and can be started manually. It updates simple-icons, regenerates icons, classifies the changes, runs validation, and opens a PR when files changed.

The update PR body includes the previous and new processed versions, added icons, removed icons, changed icons, suggested release type, and detected breaking changes.

Expanding on this project

Install dependencies with:

bun install

Use Bun for local development. The package is ESM-only and builds with tsc through scripts/build-package.ts.

The following files are generated:

• src/icons contains one generated component per icon.
• src/index.ts contains generated named exports.
• src/simple-icons-manifest.json records the processed simple-icons version, component API hash, icon names, and per-icon hashes.

dist is the build output and should not be committed.

Common commands:

bun run generate:icons
bun run classify:changes
bun run typecheck
bun run build
bun run smoke:react-native
bun run test
bun run validate

bun run smoke:react-native builds the package, creates a temporary React Native fixture, imports the package through Metro, and bundles it. This catches package export and React Native resolution problems that a plain Node import cannot catch.

To test the packed package in an app:

bun run validate
npm pack

Install the generated .tgz file into a fresh Expo or React Native app, then test both root imports and per-icon imports:

import { SiReact } from "@thinkhuman/react-native-simple-icons";
import { SiYoutube } from "@thinkhuman/react-native-simple-icons/icons/SiYoutube";

Before publishing locally, run:

bun run validate
npm pack --dry-run

prepublishOnly runs the same validation and dry-run pack check when you npm publish from your machine. The package publishes only dist, the manifest, README, license, notice, and package metadata.

Automated publish (GitHub Actions)

Pushes to main on the upstream repo run .github/workflows/publish.yml when package.json has a version that is not already on npm. Merging an icon update (or running generate:icons after bumping simple-icons) sets the version automatically; CI validates and publishes.

Forks cannot trigger a publish: the workflow checks github.repository, only runs on push to main (never on pull_request / pull_request_target), and does not use shared Actions caches.

One-time setup in ThinkHumanDotDev/react-native-simple-icons settings:

1. Create an npm automation token with publish access to @thinkhuman/react-native-simple-icons.
2. Add repository secret NPM_TOKEN with that token.
3. Optional: in Settings → Environments → npm, add required reviewers or deployment-branch rules before publish runs.

You can also run the workflow manually from the Actions tab (workflow_dispatch).

When simple-icons releases a new version, use the update workflow or run the same steps locally:

bun add --dev --exact simple-icons@latest
bun run generate:icons
bun run classify:changes --markdown .github/update-summary.md --json .github/update-summary.json
bun run validate

Commit generated icon updates separately from tooling or documentation changes when possible. A typical update commit only changes bun.lock, package.json, src/icons, src/index.ts, and src/simple-icons-manifest.json.

License

This package is MIT licensed. Icon data is generated from simple-icons, which is CC0-1.0.