• 立方厘米
  • 运行命令
  • 可用命令
  • API 密码
    • 构成部分
    • 工具函数
    • 常数
    • 类型
  • 所有权
  • 翻译

立方厘米

这个库是用 @ box/ 自定义。关于如何在生成的库中执行任务的概况可见于 运行任务 Nx文档.

运行命令

您的终端应该留在寄存器根目录的位置, 即 frontend-mono。允许 Nx 运行针对您的项目的行动,或者在必要时运行多个项目. 不导航到 packages/group-shared-features/item-icon 以运行命令.

项目的命令使用 Nx 使用的语法运行 :

Syntax: yarn nx <target name> <project name> <option overrides>
                      |              |                |
Example: yarn nx    test         products         --watch

可用命令

所有使用 Nx 的命令都可以在 project.json 文档.

• nx storybook item-icon - 发射UI组件的开发环境.
• nx build-storybook item-icon - 建立静态版本的故事书 与所有的故事.
• nx build item-icon - 使用 shared-feature-builder 执行器从 automation 软件包.
• nx lint item-icon - 运行linter过包文件.
• nx test item-icon - 进行故事书测试(视觉/互动)和笑话测试,最后编写报道报告.
• nx test-storybook item-icon - 做故事书测试 需要先在单独的终端开始故事本才能成功.
• nx test-storybook-local-coverage item-icon - 进行故事书测试,并在最后制作报道报告。 需要运行的故事书实例.
• nx test-storybook-ci item-icon - 建立故事书,并进行故事书测试,提供覆盖产出。 设计为CI使用.
• nx test-jest item-icon - 运行滑稽单元测试, 产生代码覆盖结尾.
• nx sonar item-icon - 使用声纳Qube工具对代码进行静态分析,以检测出臭虫和代码的气味。 集成为CI进程的步骤之一.
• nx chromatic item-icon - 上传故事书,供审查 框色调 ,并进行目视比较.
• nx prepare item-icon - 在Nx Release安排的软件包发布过程中运行命令.

API 密码

构成部分

• 项目Icon - 用于显示文件/文件夹图标的组件
• 项目TypeIcon - 显示项目类型图标的组件

工具函数

getFileCategoryByExtension(extension?: string): string

返回给定文件扩展名的文件类别。 如果扩展未识别,则返回 'default'。 。 。 .

import { getFileCategoryByExtension } from '@box/item-icon';

const category = getFileCategoryByExtension('pdf'); // Returns 'pdf'
const category2 = getFileCategoryByExtension('docx'); // Returns 'word-document'
const category3 = getFileCategoryByExtension('unknown'); // Returns 'default'

getColorByExtension(fileCategory: FileCategory): string | undefined

返回给定文件类别的 CSS 颜色变量。 回返 undefined 用于 falsy 输入.

import { getColorByExtension, type FileCategory } from '@box/item-icon';

const color = getColorByExtension('pdf'); // Returns 'var(--bp-watermelon-red-120, var(--watermelon-red-120))'
const color2 = getColorByExtension('image'); // Returns 'var(--bp-green-light-135, var(--green-light-120))'

常数

FILE_EXTENSION_CATEGORIES

对象映射文件类别到文件扩展名的数组 .

import { FILE_EXTENSION_CATEGORIES } from '@box/item-icon';

FILE_EXTENSION_CATEGORIES.pdf; // ['pdf']
FILE_EXTENSION_CATEGORIES.image; // ['bmp', 'cr2', 'crw', 'dng', 'gdraw', 'gif', ...]
FILE_EXTENSION_CATEGORIES.markdown; // ['md', 'markdown']
FILE_EXTENSION_CATEGORIES['word-document']; // ['doc', 'docm', 'docx']

FILE_CATEGORY_COLORS

一个对象映射文件类别到相应的"蓝图"CSS颜色变量. 用于格式化文件类型指标的一致用途 .

import { FILE_CATEGORY_COLORS } from '@box/item-icon';

FILE_CATEGORY_COLORS.pdf; // 'var(--bp-watermelon-red-120, var(--watermelon-red-120))'
FILE_CATEGORY_COLORS.image; // 'var(--bp-green-light-135, var(--green-light-120))'
FILE_CATEGORY_COLORS.markdown; // 'var(--bp-gray-100, var(--gray-100))'
FILE_CATEGORY_COLORS.video; // 'var(--bp-light-blue-115, var(--light-blue-110))'

类型

FileCategory

代表所有有效文件类别的 TypeScript 联盟类型.

import { type FileCategory } from '@box/item-icon';

type FileCategory =
    | 'audio'
    | 'boxcanvas'
    | 'boxnote'
    | 'code'
    | 'document'
    | 'docuworks-binder'
    | 'docuworks-file'
    | 'dwg'
    | 'excel-spreadsheet'
    | 'google-docs'
    | 'google-sheets'
    | 'google-slides'
    | 'illustrator'
    | 'image'
    | 'indesign'
    | 'keynote'
    | 'markdown'
    | 'numbers'
    | 'pages'
    | 'pdf'
    | 'photoshop'
    | 'powerpoint-presentation'
    | 'presentation'
    | 'spreadsheet'
    | 'text'
    | 'threed'
    | 'vector'
    | 'video'
    | 'word-document'
    | 'zip';

所有权

该特性的代码属于webapp-eng. 拥有团队的职责包括控制代码质量,提供修改指南,并与其他团队在修改方面保持一致. 征求拥有或请求哪个团队负责修改守则,将是一种良好做法.

翻译

每个地方 i18n/*.js 档案由莫吉·詹金斯管道生成和完成。 共享特性构建器复制到 dist/i18n/ 期间 build中的软件包 i18n.config.js 下级 translationDependencies。 。 。 .