迪亚通
用于Dialpad设计系统Dialtone的单曲.
迪亚通 v10: 见 DLT-2979 (英语) 编号 : #1426号 用于v10升级及其断裂变化. 这是MaJOR版本的发布.
所有单独包的拨号也单独部署. 如果您想使用单个包而不是综合的Dialtone包, 您可以在下表中查找每个软件包的文档.
使用量
下面的用法指令是用于组合包.
通过国家预防机制安装:
npm install @dialpad/dialtone @dialpad/i18n
导入 CSS
import '@dialpad/dialtone/css';
无用户构建
如果您的工程无法使用 CSS Cascade 层, 请导入无层变体 。 如果您要从 Dialtone QQ9 升级, 您可能需要使用无层构建, 除非您将您的应用程序 CSS 迁移到支持层 。 见 CSS 叠加层迁移指南 更多细节.
import '@dialpad/dialtone/css/no-layers';
他们
迪亚通有四个主题维度: 模式 (轻/暗), 品牌 (颜色调色板), 材料 和 对比 (默认/高). 每个开关通过运行时间 @dialpad/dialtone/themes/config见 主题和模式指南 为全API.
快速启动
安装 :
npm install @dialpad/dialtone
初始化( 主要js 或 App.vue) :
import { initDialtoneTheme } from '@dialpad/dialtone/themes/config';
import Dp from '@dialpad/dialtone/themes/dp';
initDialtoneTheme(Dp, 'light');
结束了。 你的应用程序现在有主题.
基本用途
import {
setMode,
setBrand,
setMaterial,
setContrast,
} from '@dialpad/dialtone/themes/config';
import Tmo from '@dialpad/dialtone/themes/tmo';
import HighContrast from '@dialpad/dialtone/themes/high-contrast';
setMode('dark'); // toggles data-dt-mode, no injection
setBrand(Tmo); // injects brand CSS, sets data-dt-brand
setMaterial('steel'); // injects material CSS, sets data-dt-material
setContrast(HighContrast); // injects contrast CSS, sets data-dt-contrast
setContrast(null); // remove contrast override
setMode 切换一个属性与预捆绑的 CSS 连接——不注入. setBrand, (中文(简体) ), setMaterial,以及 setContrast 输入每个主题覆盖 CSS.
B. 密封材料
大部分品牌都通过 shell.base.material 在他们的代号JSON. setBrand 自动应用同一漆框中的被锁材料。 自由选择品牌(dp, (中文(简体) ), tmo, (中文(简体) ), prota-deuter, (中文(简体) ), trita保持物质独立.
import { getBrandMaterial, hasBrandMaterialLock } from '@dialpad/dialtone/themes/config';
import Botany from '@dialpad/dialtone/themes/botany';
getBrandMaterial(Botany); // 'sandstone'
hasBrandMaterialLock(Botany); // true
使用这些取取器来驱动取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取.
可用主题
共50个主题. 传递主题模块到 initDialtoneTheme() 或者说 setBrand()。 。 。 .
基础 : dp(拨号板——上方其他主题层)- 搭档: 电话
标准 : 爱琴花,高山花,北极花,极地花,秋天花,蓝小时花,植物花,花砖花,黄油花,花心花,花心花,花心花,钴,铜,珊瑚取水,龙果,uca克花,花心花,高荒花,墨莓花,出窑花,薰衣草,马来果,花心花,花心花,花心花,花心花,花心花,花心花,花心花心花,花心花,花心花,花心花,花心花,花心花花,花心花,花心花,花心花心花花,花心花花花花心花花,花心花,花心花心花花等
无障碍性: 亲子生殖器, 三分母
对比度 : 高调
材料 (字符串名称,没有模块导入):砂岩,钢铁,石墨,铁,阿弥陀,玉
import ThemeName from '@dialpad/dialtone/themes/theme-name';
高级
阴影 DOM (网络组件):
通过主机元素作为第三个参数 .
initDialtoneTheme(Dp, 'light', this);
仅CSS(无JS):
@import "@dialpad/dialtone-tokens/layered/tokens-core.css";
@import "@dialpad/dialtone-tokens/layered/tokens-base-colors.css";
@import "@dialpad/dialtone-tokens/layered/tokens-dp-colors.css";
然后设置属性 :
<html data-dt-mode="light" data-dt-brand="dp" data-dt-material="sandstone" data-dt-contrast="default">
模式区 :
见 模岛部分 医生.
后向相容系统
原画 setTheme() API仍然支持现有项目。 新的项目应使用上面的分层系统来进行更小的捆绑尺寸和更细的跨越所有四个维度的切换.
import { setTheme } from '@dialpad/dialtone/themes/config';
import DpLight from '@dialpad/dialtone/themes/dp-light';
import DpDark from '@dialpad/dialtone/themes/dp-dark';
setTheme(DpLight); // auto-detected as legacy
setTheme(DpLight, document.querySelector('#my-shadow-root-host')); // Shadow DOM support
遗产主题: DpLight, (中文(简体) ), DpDark, (中文(简体) ), TmoLight, (中文(简体) ), TmoDark ——每艘舰的完整代号集(~1256KB每座主题),而分层系统小的每座分层覆盖.
Dialtone 图标
// Named import
import { DtIconArrowUp } from '@dialpad/dialtone-icons/vue';
import { DtIllustrationBlankSpace } from '@dialpad/dialtone-icons/vue';
// Default import (Preferred if using webpack as it is tree-shakeable by default)
import DtIconArrowUp from '@dialpad/dialtone-icons/vue/arrow-up';
import DtIllustrationBlankSpace from '@dialpad/dialtone-icons/vue/blank-space';
Dialtone Vue 组件
// Named import
import { DtButton } from "@dialpad/dialtone/vue"
// Default import (Preferred if using webpack as it is tree-shakeable by default)
import { DtButton } from "@dialpad/dialtone/vue/lib/button"
说明: 迪亚通克活佛2被贬. 请移入Dialtone Vue。 最新版本的Dialtone仍然支持Vue 2,是9.154.0.
Dialtone MCP 服务器
安装 MCP 服务器在您本地环境中使用,并与 Dialtone 有效开发 . 执行指令 MCP 服务器 文件夹.
关于这个雷波
@dialpad/dialtone 寄存器是一个由 Dialtone 国家防范机制的软件包和应用程序组成的单列器.
以下是包含在这个单列波中的包列表. 请注意,库(包文件夹)与 应用程序( apps 文件夹) :
dialtone/
|--- .github # Github configuration and workflows
|--- apps # Buildable and deployable applications
|--- dialtone-documentation # Documentation site
|--- common # Common files shared between packages
|--- generator-dialtone # Yeoman Generator for creating new packages
|--- packages # Libraries that are being developed within the monorepo and published to NPM/GitHub
|--- combinator # Combinator component
|--- dialtone-css # CSS library
|--- dialtone-emojis # Emoji assets
|--- dialtone-icons # SVG and Vue icons library compatible with vue@2 and vue@3
|--- dialtone-mcp-server # MCP Server
|--- dialtone-tokens # CSS Tokens library
|--- dialtone-vue # Vue component library compatible with vue@3
|--- eslint-plugin-dialtone # Custom ESLint rules for Dialtone users
|--- language-server # Language tools based on Volar Framework
|--- postcss-responsive-variations # PostCSS plugin to generate responsive classes
|--- stylelint-plugin-dialtone # Custom Stylelint rules for Dialtone users
|--- scripts # Shared scripts
单发管
Dialtone是一个单包,其中包含许多包来方便版本的维护 图书馆.
我们的捆绑是如何运作的
为了实现这一点,我们需要通过单曲创造某些配置,以便能够处理它们,即使
它们有相同的软件包名称,例如: @dialpad/dialtone-vue。 。 。 .
- 在根头 软件包.json数字 :
pnpm数字 :peerDependencyRules包含vue": "^3.2"以确保我们没有与 vue 版本相关的警告 错配.packageExtensions告诉 pnpm 用于每个软件包的 Vue 版本 .
- 在单个软件包上
package.json文件 :- 如果有人使用单个软件包, 包含具体的依赖性
- 单位
vite.config.js第3组 增加外部依赖性,以确保不会给产品造成问题.
- 单位 项目.json
- 包含隐含的依赖性,以确保NX在试图将文件复制到单包之前建立它们.
- 单位
gulpfile.cjs- 将已建文件复制到根
dist文件夹.
- 将已建文件复制到根
包含的软件包
- 迪亚通 CSS
- 迪亚通·托肯斯
- 迪亚通·韦
树摇
摇树是一种功能,允许您从捆绑中去除未使用的代码,它默认在我们的包中被启用 为 Dialtone 、 Dialtone Vue、 Dialtone 组合器和 Dialtone 图标构建进程.
我们主要通过三个机制在一揽子方案之间摇树:
将套件标记为副作用
sideEffects: false 设置后,捆绑者可以减少未使用的进口.
@dialpad/dialtone→ 软件包.json 第242行@dialpad/dialtone-vue(vue3) • 软件包.json 第145行@dialpad/dialtone-combinator→ 软件包.json 第56行@dialpad/dialtone-icons→ 软件包.json 第98行
建立无害环境管理(通过出口图提供双重无害环境管理/CJS)
套件使捆绑者的无害环境管理暴露在静态分析和树震中,并伴有CJS倒置.
@dialpad/dialtone-vue(视频3):"type"数字 :"module", (中文(简体) ),"module"数字 :"./dist/dialtone-vue.js", (中文(简体) ),"main"数字 :"./dist/dialtone-vue.cjs", (中文(简体) ),
深, 每个模块的切入点, 允许精细的导入路径
出口地图暴露出子路径条目,使消费者能够只进口他们需要的东西(这有助于刮树并避免 拉出整个捆:
@dialpad/dialtone曝光情况./vue/lib/*映射到单个组件导入.@dialpad/dialtone-vue曝光情况./lib/*用于单个部件进口.@dialpad/dialtone-icons曝光情况./vue3/*用于单个图标/喷雾导入.
可用软件包
| 名称 | 说明 | 版本 |
|---|---|---|
| 迪亚通 | 包含图书馆最新版本的组合软件包,以便于使用 | |
| 迪亚通 CSS | Dialtone内部使用的类别或样式应存放于此处,并记录在我们的网站上 apps/dialtone-documentation | |
| 迪亚通爱莫吉斯语Name | Emoji资产 | |
| Dialtone 图标 | 实施符合Dialpad设计原则和最佳做法的应用程序图标所需的资源 | |
| Dialton 符号 | Dialpad设计系统Dialtone的设计标志 以及与建造和出版有关的一切 | |
| 迪亚通·韦 | Vue 组件库,以简化和规范所有数字盘项目使用共同的UI模式和行为 | |
| Eslint 插件 | 包含规则的 ESLint 插件, 帮助开发者维持被推荐的拨号操作 | |
| 样式林插件 | StyleLint 插件, 包含规则, 帮助开发人员维护 CSS 建议的拨号操作 |
捐款
请读我们的 贡献指南 在提交拉动请求之前。 。 。 .
快开始
如果您想为 Dialtone 做贡献而不做任何本地环境设置, 您可以使用 GitHub 密码空间 您可以点击 Dialtone 右上角的绿色“ 代码” 按钮来初始化新代码空间 GitHub 页面.

请看 代码空间文件 更多信息.
地方发展
菲律宾
PNPM(国家防范机制绩效)是一个一揽子管理解决方案,旨在应对由以下因素带来的挑战: 传统软件包管理器.
我们用PNPM来管理与国家预防机制相关的一切, 添加、安装、删除和出版软件包。 。 。 .
您需要在当地安装 PNPM 来为这个项目做出贡献 . https://pnpm.io/安装
Repo通过 packageManager 输入 package.json。每回波自动使用正确版本的建议方法是 核心软件包,该船与节点.js:
安装
corepack enable
核心包装读取 packageManager 字段,并透明地使用被绑定的 pnpm 版本——无需手动切换跨重置程序.
执行
使用 PNPM 管理软件包依赖性
pnpm add eslint --filter dialtone-icons
别
用 PNPM 运行软件包脚本, 这将不使用 NX 缓存和管道, 这样你可能会失去以前需要建立的依赖关系.
pnpm run --filter dialtone-css build
无
Nx是一个有内置工具和高级CI能力的构建系统. 它帮助您维持和放大单体,无论是本地还是CI.
NX管理我们的PNPM脚本的排程和缓存.
我们仍依赖PNPM工作空间提供的软件包安装和软件包连接机制, 但使用 Nx 代替为 以最有效的方式执行我们的任务。 。 。 .
在我们的PNPM工作空间中加入Nx的主要好处之一是通过缓冲速度.
通过 NX 运行命令将使我们能够做一些事情:
- 建立项目依赖 其他项目命令, 如果需要在特定命令前运行.
- 通过将其输出保存到缓存来提高命令执行的速度.
- 运行命令于 受影响 仅限项目.
QQ您也可以使用 PNPM 运行命令,但这样做并不可取,因为您会失去NX提供的优势.
详情请检查 设置一个带有 PNPM 工作空间和 NX 的单列波
安装
建议通过以下方式在全球安装NX:
pnpm add --global nx@latest
执行
使用 NX 运行脚本, 这将使用缓存, 提高性能 , 在运行命令前建立所需的任何依赖关系.
nx run dialtone-css:build
别
尝试用 NX 安装软件包, 这完全行不通, 请使用 PNPM 代替 .
nx add eslint --filter dialtone-icons
管理项目
首先,安装所有单列波包和app的依赖性.
pnpm install
Dialtone 文档网站
nx run dialtone-documentation:start
这将启动文件网站,并观看图书馆的修改,并将随任何修改而实时更新.
访问本地服务器 : http://localhost:4000
Dialtone Vue 故事书
nx run dialtone-vue:start
通过 Dialtone Vue 访问本地故事书服务器 http://localhost:9011/
常见命令
生产建设根基工程
nx run dialtone:build
使用 --filter 用于运行特定软件包或应用程序的命令的旗帜.
添加单个软件包的依赖性
pnpm add <dependency> --filter <package or app name>
示例
pnpm add eslint --filter dialtone-icons
要安装本地依赖,只需添加 --workspace 旗帜
pnpm add <dependency> --filter <package or app name> --workspace
示例
pnpm add @dialpad/dialtone-tokens --filter dialtone-icons --workspace
运行单个软件包的命令
您可以运行命令像 build, (中文(简体) ), test, (中文(简体) ), start 单个软件包
使用 :
nx run <package/app>:<target>
示例
nx run dialtone-documentation:build
清洁的建筑文物和缓存
使用此来清除 Stale 构造文物并重置构造缓存. 常见的情况包括切换分行,排除出乎意料的构建行为出错,或者从被中断的构建中恢复. 这很少需要,因为构建脚本已经清理了自己的 dist 文件夹,而 Nx 缓存无效会自动处理大多数 staleness.
# Clean everything (dist folders and Nx cache)
pnpm clean
# Clean only dist folders (stale build artifacts)
pnpm clean:dist
# Clean only Nx cache (confused incremental builds)
pnpm clean:cache
被清理的东西:
clean:dist删除packages/dialtone-tokens/dist和 VuePress 缓存/调制目录clean:cache清除 Nx 的构建缓存( N).nx/cache(中文(简体) )clean双向运行
在另一个工程中使用本地软件包
在本地运行的前端看到本地 Dialtone 变化的一个方法是使用本地软件包.
要创建 Dialtone 软件包, 首先运行( in Dialtone repo) :
pnpm pack
这将生成一个 .tgz 文件,格式与 npm 上公布的格式相同。 要在您可以运行的另一个工程中使用此软件包 :
npm install <path to previously generated tgz file>
npm run dev
释放
目前, Dialtone 包正在以两种不同的方式发布: scheduled 财务报告和审定财务报表 manually。 。 。 .
这个 scheduled 释放仅释放更改到 production 时 manually 您可以选择释放
alpha 或者说 beta 树枝.
生产
计划
在协调世界时每星期二10点, 释放动作 将触发生产释放过程 在接下来的步骤下自动释放所有需要发布的软件包 :
- 运行
release每个项目的目标. - 合并由语义解析器创建的解析器
staging改为production树枝. - 推开
production树枝. - 这个 发布动作 将使用相应的标记发布软件包.
手动
如果您需要提前于下一个预定日期释放,您可通过 Run workflow 打开 GitHub 图像。 。 。 .
- 选择
staging树枝. - 选择
package您想要释放 或让它空出 释放所有的人.
这将触发 释放动作,在 staging ,并在接下来的步骤下自动发布所选软件包:
- 运行
release选定软件包上的目标(如果package为空). - 合并由语义解析器创建的解析器
staging改为production树枝. - 推开
production树枝. - 这个 发布动作 将使用相应的标记发布软件包.
阿尔法/贝塔
- 将您的更改合并到您想要释放的分支, 承诺并推向源代码 。 (注:如果您的拨号版本号落后于上个出品号,则可能会失败. 手动合并或更新版本编号。 )
- 转到 GitHub 图像 并单击
Run workflow。 。 。 . - 选择
alpha或者说beta树枝. - 选择
package您想要释放 或让它空出 释放所有的人.
这将触发 释放动作中,在选定的分支上发布更改,并在接下来的步骤下自动发布所选软件包:
- 运行
release选定软件包上的目标(如果package为空). - 这个 发布动作 将使用相应的标记发布软件包.
测试
运行 Vue 测试
nx run dialtone-vue:test
运行覆盖的 Vue 单元测试
nx run dialtone-vue:test:coverage
这将生成 JSON 和 HTML 报告 coverage 目录.
测试覆盖率阈值
覆盖率阈值的定义载于 vitest.config.ts 文档.
在提交PR时,CI将进行覆盖测试,如果覆盖低于阈值则失败.