# ncom

**Repository Path**: weblabsw/ncom

## Basic Information

- **Project Name**: ncom
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-16
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# New Component（ncom）

New Component 是一套**原生 Web Component** 组件库：基于 **Custom Elements** 与 **Shadow DOM**，用 TypeScript 与 Vite 开发与构建，可在任意前端栈中以标准自定义元素方式使用。

## 官网

https://ncom.lab209.com

## 快速开始（本地开发）

```bash
# 安装依赖
pnpm install
# 编译
pnpm build
# 启动example站点
pnpm dev:example
```

_**example站点启动后，按提示访问站点**_

## 仓库结构（Monorepo）

本仓库为 **pnpm workspace**，主要目录如下：

| 路径                                       | 说明                                 |
| ------------------------------------------ | ------------------------------------ |
| [packages/core](packages/core)             | 组件基类、事件与工具（`@ncom/core`） |
| [packages/components](packages/components) | UI 组件实现（`@ncom/components`）    |
| [packages/locale](packages/locale)         | 国际化（`@ncom/locale`）             |
| [packages/extensions](packages/extensions) | 扩展能力如路由（`@ncom/extensions`） |
| [packages/theme](packages/theme)           | 主题（`@ncom/theme`）                |
| [packages/all](packages/all)               | 聚合构建与对外入口（`@ncom/all`）    |
| [example](example)                         | 示例                                 |

## 安装

### 全量安装

```bash
npm i @ncom/all --save-dev
#或
pnpm add @ncom/all --save-dev

```

### 最小安装

```bash
npm i @ncom/core --save-dev
#或
pnpm add @ncom/core --save-dev
```

## 脚手架

[ncom-cli工具](https://www.npmjs.com/package/ncom-cli)

```bash
#安装
npm i ncom-cli -g
#创建应用
ncom-cli myapp
```

## 文档

1. [开发导引](doc/develop.md)
2. [基础 API](doc/api/core/README.md)
3. [组件 API](doc/api/components/README.MD)

## 浏览器支持

支持实现了 **Custom Elements v1** 与 **Shadow DOM v1** 的浏览器，例如：

Chrome 60+、Firefox 63+、Safari 10.1+、Edge 79+

## 参与贡献

欢迎提交 Issue 与 Pull Request。提交前建议本地执行 `pnpm lint:eslint`，并遵循仓库内的 Commit 规范（Commitlint + cz-git）。

## License

MIT © [weblab209]