veltra-utils
生成物
根目录执行 bun run sync-veltra-utils 或 bun run sync-skills 可重新生成 generated/。
导入约定
import {
bem,
addClass,
removeClass,
getScrollParents,
scrollIntoContainerView,
withUnit,
setStyles,
removeStyles,
zIndex,
getHighlightChunks,
Validator,
makeBEM,
createIncrease,
createToggle,
Tween,
nextFrame,
shallowComputed,
isTextNode,
isFragment,
isComment,
isTemplate,
extractNormalVNodes,
middleProxy
} from '@veltra/utils'
import { NAME_SPACE, CLS_PREFIX, FORM_EMPTY_CONTENT } from '@veltra/utils/shared'
按需引入即可;无默认导出。共享常量与部分类型也可从 @veltra/utils/shared 引用。
按目录的函数速查
DOM
| 符号 | 用途 |
|---|
addClass / removeClass | 元素 class 增删 |
getScrollParents | 可滚动祖先链 |
scrollIntoContainerView | 在容器内滚入视区 |
withUnit | 数值补单位 |
setStyles / removeStyles | 行内样式批量设置/清理 |
zIndex | 全局 z-index 栈 |
getHighlightChunks | 文本高亮分片 |
bem | 默认 u- 前缀的 BEM 工厂(见 bem-guide.md) |
表单校验
辅助
| 符号 | 用途 |
|---|
makeBEM | 自定义前缀 BEM 工厂 |
createIncrease / createToggle | 递增 id、布尔切换 |
Tween | 补间 |
nextFrame | requestAnimationFrame 封装 |
shallowComputed | 浅层 computed 辅助 |
Vue 辅助
| 符号 | 用途 |
|---|
isTextNode / isFragment / isComment / isTemplate | 节点类型判断 |
extractNormalVNodes | 规范化 vnode 列表 |
响应式
常量(@veltra/utils/shared)
| 符号 | 用途 |
|---|
NAME_SPACE / CLS_PREFIX | 类名前缀 |
FORM_EMPTY_CONTENT | 表单只读占位展示 |
共享类型速查
常用类型定义在 types/ 中镜像于 shared-types.md,例如:
ComponentSize、ColorType(见 types/component-common.ts)FormComponentProps 及表单上下文类型(见 types/form-context.ts 等)
具体字段以生成文件中的源码为准。