@brightlocal/illustrations

中文文档
0.7.0发布于 2026/10/16MITTypeScriptESM + CJS零依赖近 30 天下载 2159

BrightLocal Design System Illustrations

原始使用文档
文档目录9 节
  1. Installation
  2. Categories
  3. Usage
  4. Direct imports
  5. Props
  6. Illustrations & Globey (SVG)
  7. Globey Scenes & Visuals ( <img> -based)
  8. Theme Support
  9. License

@brightlocal/illustrations

BrightLocal Design System Illustrations - A collection of custom SVG illustrations, character scenes, and static images.

Installation

pnpm add @brightlocal/illustrations

Categories

CategoryDescriptionImport path
IllustrationsSVG illustrations with surface-type variants@brightlocal/illustrations/illustrations/*
GlobeyCharacter emotion/direction variants@brightlocal/illustrations/globey/*
Globey ScenesComposite character scenes (SVG files rendered via <img>)@brightlocal/illustrations/globey-scenes/*
VisualsRaster image components (JPG/PNG)@brightlocal/illustrations/visuals/*

Usage

import { SmallBusiness } from "@brightlocal/illustrations";

function App() {
  return (
    <div>
      {/* Default size: md (130x130) */}
      <SmallBusiness />

      {/* Size scale step, or a custom size */}
      <SmallBusiness size="lg" />
      <SmallBusiness size={400} />

      {/* Responsive with Tailwind */}
      <SmallBusiness className="w-64 h-64" />
    </div>
  );
}

Direct imports

You can also import from each category directly:

import { SmallBusiness } from "@brightlocal/illustrations/illustrations/small-business";
import { GlobeyCalmClosed } from "@brightlocal/illustrations/globey/globey-calm-closed";
import { GlobeyFixingFault } from "@brightlocal/illustrations/globey-scenes/globey-fixing-fault";
import { MapBackgroundDark } from "@brightlocal/illustrations/visuals/map-background-dark";

Props

Illustrations & Globey (SVG)

  • size - Width and height. Illustrations: "md" (130) | "lg" (300) | px/CSS value, default "md". Globey: px/CSS value, default 250
  • variant - Surface-type variant: "dark" | "white" (auto white/dark when omitted)
  • className - CSS classes for additional styling

Globey Scenes & Visuals (<img>-based)

  • width - Image width (default varies per component)
  • height - Image height (default varies per component)
  • alt - Alt text (default: "")
  • Standard <img> HTML attributes

Theme Support

All SVG illustrations automatically switch between light and dark mode based on the current theme using Tailwind's dark: variant.

License

UNLICENSED

版本与发布记录

@brightlocal/illustrations 共发布 8 个版本,首次发布于 2025/11/17;过去 12 个月发布了 8 个版本。

版本发布日期距今
0.7.0latest2026/10/1623 天前
0.6.02026/08/063 个月前
0.5.02026/06/114 个月前
0.4.02026/05/086 个月前
0.3.02026/04/176 个月前
0.2.02026/02/098 个月前

关于 @brightlocal/illustrations 的常见问题

@brightlocal/illustrations 是什么?

BrightLocal Design System Illustrations

如何安装 @brightlocal/illustrations?

在项目目录运行 npm install @brightlocal/illustrations,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^17.0.0 || ^18.0.0 || ^19.0.0)、react-dom(^17.0.0 || ^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@brightlocal/illustrations 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@brightlocal/illustrations 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@brightlocal/illustrations 可以商用吗?

@brightlocal/illustrations 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@brightlocal/illustrations 的下载量有多少?

根据 npm 官方下载统计,@brightlocal/illustrations 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,159 次,日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@brightlocal/illustrations 还在维护吗?

最新版本 0.7.0 发布于 2026/10/16(23 天前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2025/11/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。