@aquera/nile-glyph

中文文档
1.0.13发布于 2026/10/30MITTypeScriptES Module近 30 天下载 1993

Glyphs for the Nile Design System

原始使用文档
文档目录10 节
  1. Installation
  2. Usage
  3. Basic Usage
  4. Properties
  5. Examples
  6. CSS Custom Properties
  7. Programmatic Imports
  8. Exports
  9. Development
  10. Release Notes

@aquera/nile-glyph

Icon components and glyph data for the Nile Design System.

Installation

npm install @aquera/nile-glyph
# or
yarn add @aquera/nile-glyph

Usage

Basic Usage

Import and use the <nile-glyph> web component:

<nile-glyph name="alert"></nile-glyph>

The component self-registers as a custom element when imported:

import '@aquera/nile-glyph';

Properties

PropertyTypeDefaultDescription
namestring—The name of the icon to display
setstring'local'The icon set to use
sizenumber16Icon size in pixels
colorstring—Icon fill color
methodstring'fill'Rendering method ('fill' or 'stroke')
descriptionstring''Accessible description for the icon
pushbooleanfalseAdds right margin spacing
noFillbooleanfalsePrevents fill from being applied to paths
framestring—Custom viewBox dimensions
customSvgPathstring—URL to a custom SVG file to load

Examples

<!-- Icon with custom size and color -->
<nile-glyph name="alert" size="24" color="#ff0000"></nile-glyph>

<!-- Stroke-based icon -->
<nile-glyph name="calendar" method="stroke"></nile-glyph>

<!-- Icon with accessible description -->
<nile-glyph name="close" description="Close dialog"></nile-glyph>

<!-- Custom SVG from URL -->
<nile-glyph customSvgPath="/assets/my-icon.svg"></nile-glyph>

CSS Custom Properties

PropertyDescription
--nile-svg-heightIcon height
--nile-svg-widthIcon width
--nile-svg-fillIcon fill color
--nile-svg-strokeIcon stroke color
--nile-svg-stroke-widthIcon stroke width
--nile-spacing-lgPush margin spacing

Programmatic Imports

// Import the component class
import { NileGlyph } from '@aquera/nile-glyph';

// Import individual icon SVG data
import * as Icons from '@aquera/nile-glyph/icons';

// Import the alias map
import { aliasMap } from '@aquera/nile-glyph';

Exports

Entry PointDescription
@aquera/nile-glyphMain entry — NileGlyph, aliasMap, Icons
@aquera/nile-glyph/iconsIndividual icon SVG data (base64)
@aquera/nile-glyph/nile-glyphNileGlyph component only

Development

This repo (aquerateam/nile-glyph-registry) holds the package at its root and the glyph intake Slack bot (Nirman) in bot/. Both moved here from aquerateam/design-system on October 27, 2026, history included.

yarn install --frozen-lockfile
yarn build          # runs prebuild: icon files + tokens from assets/source/*.svg
yarn package        # CDN bundle (dist/index.js)
yarn test
  • New icons go in assets/source/ as SVGs, usually through the bot: an upload in Slack opens a glyph/* branch, whose pipeline builds the icon files, bumps the patch version and adds the release-notes entry below.
  • A version change merged to master publishes to npm and to ui-cdn.dev.aqueralabs.com/nile-glyph/<version>/. A release/* branch publishes to /nile-glyph/release/.
  • The bot deploys only through the custom pipeline foundation-builder-deploy (see bot/deploy/).

Release Notes

In this section, you can find the updates for each release of @aquera/nile-glyph. It's a good practice to maintain detailed release notes to help users and developers understand what changes have been made from one version to another and how these changes might affect their projects.

Version 1.0.13 (October 30, 2026)

  • Nile Glyph: Added New NxtGen Icon - ng-bar-chart-error (UIF-1404)

Version 1.0.12 (October 28, 2026)

  • Nile Glyph: Added New NxtGen Icon - ng-hurricane-01 (UIF-1402)

Version 1.0.11 (October 28, 2026)

  • Nile Glyph: Added New NxtGen Icon - ng-gift-02 (UIF-1401)

Version 1.0.10 (October 27, 2026)

  • Nile Glyph: Added New NxtGen Icon - ng-star-04 (UIF-1399)

Version 1.0.9 (October 23, 2026)

  • Nile Glyph: Added New NxtGen Icon - ng-array-integer (UIF-1394)
  • Nile Glyph: Added New NxtGen Icon - ng-array-objects (UIF-1394)
  • Nile Glyph: Added New NxtGen Icon - ng-array-strings (UIF-1394)

Version 1.0.8 (October 05, 2026)

  • Nile Glyph: Added 1 New NxtGen Icon - ng-ai-prompt (UIF-1376)

Version 1.0.7 (June 30, 2026)

  • Nile Glyph: Added 2 New NxtGen Icons (UIF-1283)

Version 1.0.6 (June 01, 2026)

  • Nile Glyph: Added 3 New NxtGen Icons (UIF-1248)

Version 1.0.5 (May 29, 2026)

  • Nile Glyph: Added 21 New NxtGen Icons (UIF-1244)

Version 1.0.4 (May 28, 2026)

  • Nile Glyph: Added 21 New NxtGen Icons (UIF-1241)

Version 1.0.3 (April 27, 2026)

  • Nile Glyph: Added 21 New NxtGen Icons (UIF-1202)

Version 1.0.2 (April 15, 2026)

  • Nile Glyph: Added Sql Server and Open Search Glyph (UIF-1183)

Version 1.0.1 (April 07, 2026)

  • Nile Glyph: Added Colorize Glyph (UIF-1175)

Version 1.0.0 (March 26, 2026)

  • Created Nile Glyph Component.
  • 2200+ Glyphs(Icons) available out of the box.

版本与发布记录

@aquera/nile-glyph 共发布 14 个版本,首次发布于 2026/03/26;过去 12 个月发布了 14 个版本。

版本发布日期距今
1.0.13latest2026/10/308 天前
1.0.122026/10/2810 天前
1.0.112026/10/2810 天前
1.0.102026/10/2711 天前
1.0.92026/10/2315 天前
1.0.82026/10/051 个月前

关于 @aquera/nile-glyph 的常见问题

@aquera/nile-glyph 是什么?

Glyphs for the Nile Design System

如何安装 @aquera/nile-glyph?

在项目目录运行 npm install @aquera/nile-glyph,或使用 pnpm add / yarn add / bun add。

@aquera/nile-glyph 支持 TypeScript 吗?

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

@aquera/nile-glyph 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@aquera/nile-glyph 可以商用吗?

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

@aquera/nile-glyph 的下载量有多少?

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

@aquera/nile-glyph 还在维护吗?

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