# @dotglitch/ngx-common 中文文档

规范地址：https://npmcn.com/package/%40dotglitch/ngx-common/

版本：3\.0\.0-beta\.2
npm 元数据更新时间：2026-02-28T23:17:42.411Z
中文译文更新时间：2026-11-13T04:40:00.095Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dotglitch/ngx-common
原文对照：https://npmcn.com/package/%40dotglitch/ngx-common/?lang=original
项目主页：https://github.com/knackstedt/dotglitch-ngx#readme
源码仓库：https://github.com/knackstedt/dotglitch-ngx

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.2 MB，148 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/common \>=17\.0\.0，@angular/core \>=17\.0\.0，@angular/cdk \>=17\.0\.0，@angular/material \>=17\.0\.0，angular-split \>=15\.0\.0，gsap \>=3\.12\.0，monaco-editor \>=0\.40\.0，ngx-scrollbar \>=12\.0\.0，ngx-tabulator-tables \>=0\.2\.8，path-browserify \>=1\.0\.0，ulidx \>=2\.0\.0
- 首次发布：2023-08-23T19:37:24.060Z
- 最新版本发布：2026-02-28T23:17:42.251Z
- 近 30 天下载量：2309（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 2 个）

## 中文简介

常用的角构件和公用设施.

## 安装

```sh
npm install @dotglitch/ngx-common
```

也可以使用：`pnpm add @dotglitch/ngx-common`、`yarn add @dotglitch/ngx-common`、`bun add @dotglitch/ngx-common`

## README

[

# ngx - 常见

](https://dotglitch.dev/#/ContextMenuLibrary)

\`dotglitch/ngx-common'为角化应用提供一系列常用组件、指令和服务.

[![npm](https://img.shields.io/npm/v/@dotglitch/ngx-common.svg)](https://www.npmjs.com/package/@dotglitch/ngx-common) [![npm](https://img.shields.io/npm/dm/@dotglitch/ngx-common.svg)](https://www.npmjs.com/package/@dotglitch/ngx-common) [![npm downloads](https://img.shields.io/npm/dt/@dotglitch/ngx-common.svg)](https://npmjs.org/@dotglitch/ngx-common) [![GitHub stars](https://img.shields.io/github/stars/knackstedt/dotglitch-ngx.svg?label=GitHub%20Stars&style=flat)](https://github.com/knackstedt/dotglitch-ngx)

# 快速启动

## 安装

```bash
$ npm install @dotglitch/ngx-common
```

## 可选的依赖关系

此库使用 **次要条目点** 使核心捆绑小,并使重依赖性具有可选性。 如果您使用以下任一组件,则必须安装各自的对等依赖性:

| 构成部分 | 入口 | 同伴依赖关系 |
| --- | --- | --- |
| **虚拟系统** | `@dotglitch/ngx-common/vscode` | `monaco-editor`, (中文(简体) ), `path-browserify` |
| **文件管理员** | `@dotglitch/ngx-common/filemanager` | `angular-split`, (中文(简体) ), `ngx-scrollbar`, (中文(简体) ), `ulidx` |
| **命令调色板** | `@dotglitch/ngx-common/command-palette` | `ngx-scrollbar` |
| **工具提示/降下** | `@dotglitch/ngx-common/tooltip` | `ulidx` |
| **菜单** | `@dotglitch/ngx-common/menu` | `ulidx` |
| **重叠打包器** | `@dotglitch/ngx-common/overlay-wrapper` | `gsap` |

* * *

## 特征

-   **核心组成部分和服务**
    
    -   [懒惰装入器](https://npmcn.com/package/%40dotglitch/ngx-common/src/components/lazy-loader/README.md)
    -   [获取服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/fetch.md)
    -   [扶养服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/dependency.md)
    -   [键盘服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/keyboard.md)
    -   [对话框服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/dialog.md)
    -   [导航服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/navigation.md)
    -   [主题服务](https://npmcn.com/package/%40dotglitch/ngx-common/src/services/theme.md)
-   **二级条目(可选)**
    
    -   [VS 代码包装](https://npmcn.com/package/%40dotglitch/ngx-common/src/components/vscode/README.md) (单位:千美元)`/vscode`(中文(简体) )
    -   [文件管理器](https://npmcn.com/package/%40dotglitch/ngx-common/src/components/filemanager/filemanager.component.ts) (单位:千美元)`/filemanager`(中文(简体) )
    -   [命令调色板](https://npmcn.com/package/%40dotglitch/ngx-common/src/components/command-palette/command-palette.component.ts) (单位:千美元)`/command-palette`(中文(简体) )
    -   [过渡小组](https://npmcn.com/package/%40dotglitch/ngx-common/src/components/overlay-wrapper/overlay-wrapper.component.ts) (单位:千美元)`/overlay-wrapper`(中文(简体) )
-   **指令和管道**
    
    -   [App 菜单和上下文菜单](https://npmcn.com/package/%40dotglitch/ngx-common/src/directives/menu.md) (单位:千美元)`/menu`(中文(简体) )
    -   [工具提示](https://npmcn.com/package/%40dotglitch/ngx-common/src/directives/tooltip.md) (单位:千美元)`/tooltip`(中文(简体) )
    -   [HTML 密码](https://npmcn.com/package/%40dotglitch/ngx-common/src/pipes/html-bypass.md)
    -   [资源通道](https://npmcn.com/package/%40dotglitch/ngx-common/src/pipes/resource-bypass.md)
    -   [脚本- Bypass](https://npmcn.com/package/%40dotglitch/ngx-common/src/pipes/script-bypass.md)
    -   [样式比通](https://npmcn.com/package/%40dotglitch/ngx-common/src/pipes/style-bypass.md)
    -   [URL 密码](https://npmcn.com/package/%40dotglitch/ngx-common/src/pipes/url-bypass.md)

## 常见问题

### @dotglitch/ngx-common 是什么？

常用的角构件和公用设施\.

### 如何安装 @dotglitch/ngx-common？

在项目目录运行 npm install @dotglitch/ngx-common，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/common（\>=17\.0\.0）、@angular/core（\>=17\.0\.0）、@angular/cdk（\>=17\.0\.0）、@angular/material（\>=17\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dotglitch/ngx-common 支持 TypeScript 吗？

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

### @dotglitch/ngx-common 支持 ESM 还是 CommonJS？

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

### @dotglitch/ngx-common 可以商用吗？

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

### @dotglitch/ngx-common 的下载量有多少？

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

### @dotglitch/ngx-common 还在维护吗？

最新版本 3\.0\.0-beta\.2 发布于 2026/03/01（8 个月前）；至今共发布 104 个版本，其中过去 12 个月发布了 2 个；首次发布于 2023/08/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

