@antsoo-lib/components 0.1.2 → 0.1.4

package/src/theme/interface/seeds.ts

@@ -0,0 +1,221 @@
+import type { PresetColorType } from './presetColors'
+
+// ======================================================================
+// ==                            Seed Token                            ==
+// ======================================================================
+// 🔥🔥🔥🔥🔥🔥🔥 DO NOT MODIFY THIS. PLEASE CONTACT DESIGNER. 🔥🔥🔥🔥🔥🔥🔥
+
+export interface SeedToken extends PresetColorType {
+  //  ----------   Color   ---------- //
+
+  /**
+   * @nameZH 品牌主色
+   * @nameEN Brand Color
+   * @desc 品牌色是体现产品特性和传播理念最直观的视觉元素之一。在你完成品牌主色的选取之后，我们会自动帮你生成一套完整的色板，并赋予它们有效的设计语义
+   * @descEN Brand color is one of the most direct visual elements to reflect the characteristics and communication of the product. After you have selected the brand color, we will automatically generate a complete color palette and assign it effective design semantics.
+   */
+  colorPrimary: string
+  // 子品牌主色，二级菜单颜色
+  colorSub: string
+
+  /**
+   * @nameZH 成功色
+   * @nameEN Success Color
+   * @desc 用于表示操作成功的 Token 序列，如 Result、Progress 等组件会使用该组梯度变量。
+   * @descEN Used to represent the token sequence of operation success, such as Result, Progress and other components will use these map tokens.
+   */
+  colorSuccess: string
+
+  /**
+   * @nameZH 警戒色
+   * @nameEN Warning Color
+   * @desc 用于表示操作警告的 Token 序列，如 Notification、 Alert等警告类组件或 Input 输入类等组件会使用该组梯度变量。
+   * @descEN Used to represent the warning map token, such as Notification, Alert, etc. Alert or Control component(like Input) will use these map tokens.
+   */
+  colorWarning: string
+
+  /**
+   * @nameZH 错误色
+   * @nameEN Error Color
+   * @desc 用于表示操作失败的 Token 序列，如失败按钮、错误状态提示（Result）组件等。
+   * @descEN Used to represent the visual elements of the operation failure, such as the error Button, error Result component, etc.
+   */
+  colorError: string
+
+  /**
+   * @nameZH 信息色
+   * @nameEN Info Color
+   * @desc 用于表示操作信息的 Token 序列，如 Alert 、Tag、 Progress 等组件都有用到该组梯度变量。
+   * @descEN Used to represent the operation information of the Token sequence, such as Alert, Tag, Progress, and other components use these map tokens.
+   */
+  colorInfo: string
+
+  /**
+   * @nameZH 基础文本色
+   * @nameEN Seed Text Color
+   * @desc 用于派生文本色梯度的基础变量，v5 中我们添加了一层文本色的派生算法可以产出梯度明确的文本色的梯度变量。但**请不要在代码中直接使用该 Seed Token**！
+   * @descEN Used to derive the base variable of the text color gradient. In v5, we added a layer of text color derivation algorithm to produce gradient variables of text color gradient. But please do not use this Seed Token directly in the code!
+   */
+  colorTextBase: string
+
+  /**
+   * @nameZH 基础背景色
+   * @nameEN Seed Background Color
+   * @desc 用于派生背景色梯度的基础变量，v5 中我们添加了一层背景色的派生算法可以产出梯度明确的背景色的梯度变量。但 **请不要在代码中直接使用该 Seed Token** ！
+   * @descEN Used to derive the base variable of the background color gradient. In v5, we added a layer of background color derivation algorithm to produce map token of background color. But PLEASE DO NOT USE this Seed Token directly in the code!
+   */
+  colorBgBase: string
+  // 子品牌背景色，二级菜单背景色
+  colorBgSub: string
+
+  //  ----------   Font   ---------- //
+
+  /**
+   * @nameZH 字体
+   * @nameEN FontFamily
+   * @desc Ant Design 的字体家族中优先使用系统默认的界面字体，同时提供了一套利于屏显的备用字体库，来维护在不同平台以及浏览器的显示下，字体始终保持良好的易读性和可读性，体现了友好、稳定和专业的特性。
+   */
+  fontFamily: string
+
+  /**
+   * @nameZH 默认字号
+   * @nameEN Default Font Size
+   * @desc 设计系统中使用最广泛的字体大小，文本梯度也将基于该字号进行派生。
+   * @default 14
+   */
+  fontSize: number
+
+  //  ----------   Line   ---------- //
+
+  /**
+   * @nameZH 基础线宽
+   * @nameEN Base Line Width
+   * @desc 用于控制组件边框、分割线等的宽度
+   * @descEN Border width of base components
+   */
+  lineWidth: number
+
+  /**
+   * @nameZH 线条样式
+   * @nameEN Line Style
+   * @desc 用于控制组件边框、分割线等的样式，默认是实线
+   * @descEN Border style of base components
+   */
+  lineType: string
+
+  //  ----------   BorderRadius   ---------- //
+
+  /**
+   * @nameZH 基础圆角
+   * @nameEN Base Border Radius
+   * @descEN Border radius of base components
+   * @desc 基础组件的圆角大小，例如按钮、输入框、卡片等
+   */
+  borderRadius: number
+
+  //  ----------   Size   ---------- //
+
+  /**
+   * @nameZH 尺寸变化单位
+   * @nameEN Size Change Unit
+   * @desc 用于控制组件尺寸的变化单位，在 Ant Design 中我们的基础单位为 4 ，便于更加细致地控制尺寸梯度
+   * @descEN The unit of size change, in Ant Design, our base unit is 4, which is more fine-grained control of the size step
+   * @default 4
+   */
+  sizeUnit: number
+
+  /**
+   * @nameZH 尺寸步长
+   * @nameEN Size Base Step
+   * @desc 用于控制组件尺寸的基础步长，尺寸步长结合尺寸变化单位，就可以派生各种尺寸梯度。通过调整步长即可得到不同的布局模式，例如 V5 紧凑模式下的尺寸步长为 2
+   * @descEN The base step of size change, the size step combined with the size change unit, can derive various size steps. By adjusting the step, you can get different layout modes, such as the size step of the compact mode of V5 is 2
+   * @default 4
+   */
+  sizeStep: number
+
+  /**
+   * @nameZH 组件箭头尺寸
+   */
+  sizePopupArrow: number
+
+  /**
+   * @nameZH 基础高度
+   * @nameEN Base Control Height
+   * @desc Ant Design 中按钮和输入框等基础控件的高度
+   * @descEN The height of the basic controls such as buttons and input boxes in Ant Design
+   * @default 32
+   */
+  controlHeight: number
+
+  //  ----------   zIndex   ---------- //
+
+  /**
+   * @nameZH 基础 zIndex
+   * @nameEN Base zIndex
+   * @desc 所有组件的基础 Z 轴值，用于一些悬浮类的组件的可以基于该值 Z 轴控制层级，例如 BackTop、 Affix 等
+   * @descEN The base Z axis value of all components, which can be used to control the level of some floating components based on the Z axis value, such as BackTop, Affix, etc.
+   *
+   * @default 0
+   */
+  zIndexBase: number
+
+  /**
+   * @nameZH 浮层基础 zIndex
+   * @nameEN popup base zIndex
+   * @desc 浮层类组件的基础 Z 轴值，用于一些悬浮类的组件的可以基于该值 Z 轴控制层级，例如 FloatButton、 Affix、Modal 等
+   * @descEN Base zIndex of component like FloatButton, Affix which can be cover by large popup
+   * @default 1000
+   */
+  zIndexPopupBase: number
+
+  //  ----------   Opacity   ---------- //
+
+  /**
+   * @nameZH 图片不透明度
+   * @nameEN Define default Image opacity. Useful when in dark-like theme
+   */
+  opacityImage: number
+
+  //  ----------   motion   ---------- //
+  // TODO: 缺一个懂 motion 的人来收敛 Motion 相关的 Token
+
+  /**
+   * @nameZH 动画时长变化单位
+   * @nameEN Animation Duration Unit
+   * @desc 用于控制动画时长的变化单位
+   * @descEN The unit of animation duration change
+   * @default 100ms
+   */
+  motionUnit: number
+
+  /**
+   * @nameZH 动画基础时长
+   */
+  motionBase: number
+
+  motionEaseOutCirc: string
+
+  motionEaseInOutCirc: string
+
+  motionEaseInOut: string
+
+  motionEaseOutBack: string
+
+  motionEaseInBack: string
+
+  motionEaseInQuint: string
+
+  motionEaseOutQuint: string
+
+  motionEaseOut: string
+
+  //  ----------   Style   ---------- //
+
+  /**
+   * @nameZH 线框风格
+   * @nameEN Wireframe Style
+   * @desc 用于将组件的视觉效果变为线框化，如果需要使用 V4 的效果，需要开启配置项
+   * @default false
+   */
+  wireframe: boolean
+}

package/src/theme/internal.ts

@@ -0,0 +1,145 @@
+import type { ComputedRef, InjectionKey, Ref } from 'vue'
+import {
+  computed,
+  defineComponent,
+  inject,
+  provide,
+  shallowRef,
+  triggerRef,
+  unref,
+  watch,
+} from 'vue'
+
+import type { CSSInterpolation, Theme } from '../_util/cssinjs'
+import { createTheme, useCacheToken, useStyleRegister } from '../_util/cssinjs'
+import type { VueNode } from '../_util/type'
+import { objectType } from '../_util/type'
+import type {
+  AliasToken,
+  GlobalToken,
+  MapToken,
+  OverrideToken,
+  PresetColorKey,
+  PresetColorType,
+  SeedToken,
+} from './interface'
+import { PresetColors } from './interface'
+import defaultDerivative from './themes/default'
+import defaultSeedToken from './themes/seed'
+import formatToken from './util/alias'
+import type { FullToken } from './util/genComponentStyleHook'
+import genComponentStyleHook from './util/genComponentStyleHook'
+import statisticToken, { merge as mergeToken, statistic } from './util/statistic'
+
+const defaultTheme = createTheme(defaultDerivative)
+
+export {
+  genComponentStyleHook,
+  mergeToken,
+  // colors
+  PresetColors,
+  // Statistic
+  statistic,
+  statisticToken,
+  // hooks
+  useStyleRegister,
+}
+export type {
+  AliasToken,
+  // FIXME: Remove this type
+  AliasToken as DerivativeToken,
+  FullToken,
+  PresetColorKey,
+  PresetColorType,
+  SeedToken,
+}
+
+// ================================ Context =================================
+// To ensure snapshot stable. We disable hashed in test env.
+export const defaultConfig = {
+  token: defaultSeedToken,
+  hashed: true,
+}
+
+export interface DesignTokenContext {
+  token: Partial<AliasToken>
+  theme?: Theme<SeedToken, MapToken>
+  components?: OverrideToken
+  hashed?: string | boolean
+}
+//defaultConfig
+const DesignTokenContextKey: InjectionKey<ComputedRef<DesignTokenContext>> =
+  Symbol('DesignTokenContext')
+
+export const globalDesignTokenApi = shallowRef<DesignTokenContext>()
+
+export const useDesignTokenProvider = (value: ComputedRef<DesignTokenContext>) => {
+  provide(DesignTokenContextKey, value)
+  watch(
+    value,
+    () => {
+      globalDesignTokenApi.value = unref(value)
+      triggerRef(globalDesignTokenApi)
+    },
+    { immediate: true, deep: true },
+  )
+}
+
+export const useDesignTokenInject = () => {
+  return inject(
+    DesignTokenContextKey,
+    computed(() => globalDesignTokenApi.value || defaultConfig),
+  )
+}
+export const DesignTokenProvider = defineComponent({
+  props: {
+    value: objectType<DesignTokenContext>(),
+  },
+  setup(props, { slots }) {
+    useDesignTokenProvider(computed(() => props.value))
+    return () => {
+      return slots.default?.()
+    }
+  },
+})
+// ================================== Hook ==================================
+export function useToken(): [
+  ComputedRef<Theme<SeedToken, MapToken>>,
+  ComputedRef<GlobalToken>,
+  ComputedRef<string>,
+] {
+  const designTokenContext = inject<ComputedRef<DesignTokenContext>>(
+    DesignTokenContextKey,
+    computed(() => globalDesignTokenApi.value || defaultConfig),
+  )
+
+  const salt = computed(() => `${designTokenContext.value.hashed || ''}`)
+
+  const mergedTheme = computed(() => designTokenContext.value.theme || defaultTheme)
+
+  const cacheToken = useCacheToken<GlobalToken, SeedToken>(
+    mergedTheme,
+    computed(() => [defaultSeedToken, designTokenContext.value.token]),
+    computed(() => ({
+      salt: salt.value,
+      override: {
+        override: designTokenContext.value.token,
+        ...designTokenContext.value.components,
+      },
+      formatToken,
+    })),
+  )
+
+  return [
+    mergedTheme,
+    computed(() => cacheToken.value[0]),
+    computed(() => (designTokenContext.value.hashed ? cacheToken.value[1] : '')),
+  ]
+}
+
+export type UseComponentStyleResult = [(node: VueNode) => VueNode, Ref<string>]
+
+export type GenerateStyle<
+  ComponentToken extends object = AliasToken,
+  ReturnType = CSSInterpolation,
+> = (token: ComponentToken) => ReturnType

package/src/theme/themes/ColorMap.ts

@@ -0,0 +1,20 @@
+import type { ColorNeutralMapToken } from '../interface'
+
+export interface ColorMap {
+  1: string
+  2: string
+  3: string
+  4: string
+  5: string
+  6: string
+  7: string
+  8: string
+  9: string
+  10: string
+}
+
+export type GenerateColorMap = (baseColor: string) => ColorMap
+export type GenerateNeutralColorMap = (
+  bgBaseColor: string,
+  textBaseColor: string,
+) => ColorNeutralMapToken

package/src/theme/themes/compact/genCompactSizeMapToken.ts

@@ -0,0 +1,19 @@
+import type { SeedToken, SizeMapToken } from '../../interface'
+
+export default function genSizeMapToken(token: SeedToken): SizeMapToken {
+  const { sizeUnit, sizeStep } = token
+
+  const compactSizeStep = sizeStep - 2
+
+  return {
+    sizeXXL: sizeUnit * (compactSizeStep + 10),
+    sizeXL: sizeUnit * (compactSizeStep + 6),
+    sizeLG: sizeUnit * (compactSizeStep + 2),
+    sizeMD: sizeUnit * (compactSizeStep + 2),
+    sizeMS: sizeUnit * (compactSizeStep + 1),
+    size: sizeUnit * compactSizeStep,
+    sizeSM: sizeUnit * compactSizeStep,
+    sizeXS: sizeUnit * (compactSizeStep - 1),
+    sizeXXS: sizeUnit * (compactSizeStep - 1),
+  }
+}

package/src/theme/themes/compact/index.ts

@@ -0,0 +1,27 @@
+import type { DerivativeFunc } from '../../../_util/cssinjs'
+import type { MapToken, SeedToken } from '../../interface'
+import defaultAlgorithm from '../default'
+import genControlHeight from '../shared/genControlHeight'
+import genFontMapToken from '../shared/genFontMapToken'
+import genCompactSizeMapToken from './genCompactSizeMapToken'
+
+const derivative: DerivativeFunc<SeedToken, MapToken> = (token, mapToken) => {
+  const mergedMapToken = mapToken ?? defaultAlgorithm(token)
+
+  const fontSize = mergedMapToken.fontSizeSM // Smaller size font-size as base
+  const controlHeight = mergedMapToken.controlHeight - 4
+
+  return {
+    ...mergedMapToken,
+    ...genCompactSizeMapToken(mapToken ?? token),
+
+    // font
+    ...genFontMapToken(fontSize),
+
+    // controlHeight
+    controlHeight,
+    ...genControlHeight({ ...mergedMapToken, controlHeight }),
+  }
+}
+
+export default derivative

package/src/theme/themes/dark/colorAlgorithm.ts

@@ -0,0 +1,9 @@
+import { TinyColor } from '@ctrl/tinycolor'
+
+export const getAlphaColor = (baseColor: string, alpha: number) =>
+  new TinyColor(baseColor).setAlpha(alpha).toRgbString()
+
+export const getSolidColor = (baseColor: string, brightness: number) => {
+  const instance = new TinyColor(baseColor)
+  return instance.lighten(brightness).toHexString()
+}

package/src/theme/themes/dark/colors.ts

@@ -0,0 +1,54 @@
+import { generate } from '@ant-design/colors'
+
+import type { GenerateColorMap, GenerateNeutralColorMap } from '../ColorMap'
+import { getAlphaColor, getSolidColor } from './colorAlgorithm'
+
+export const generateColorPalettes: GenerateColorMap = (baseColor: string) => {
+  const colors = generate(baseColor, { theme: 'dark' })
+  return {
+    1: colors[0],
+    2: colors[1],
+    3: colors[2],
+    4: colors[3],
+    5: colors[6],
+    6: colors[5],
+    7: colors[4],
+    8: colors[6],
+    9: colors[5],
+    10: colors[4],
+    // 8: colors[9],
+    // 9: colors[8],
+    // 10: colors[7],
+  }
+}
+
+export const generateNeutralColorPalettes: GenerateNeutralColorMap = (
+  bgBaseColor: string,
+  textBaseColor: string,
+) => {
+  const colorBgBase = bgBaseColor || '#000'
+  const colorTextBase = textBaseColor || '#fff'
+
+  return {
+    colorBgBase,
+    colorTextBase,
+
+    colorText: getAlphaColor(colorTextBase, 0.85),
+    colorTextSecondary: getAlphaColor(colorTextBase, 0.65),
+    colorTextTertiary: getAlphaColor(colorTextBase, 0.45),
+    colorTextQuaternary: getAlphaColor(colorTextBase, 0.25),
+
+    colorFill: getAlphaColor(colorTextBase, 0.18),
+    colorFillSecondary: getAlphaColor(colorTextBase, 0.12),
+    colorFillTertiary: getAlphaColor(colorTextBase, 0.08),
+    colorFillQuaternary: getAlphaColor(colorTextBase, 0.04),
+
+    colorBgElevated: getSolidColor(colorBgBase, 12),
+    colorBgContainer: getSolidColor(colorBgBase, 8),
+    colorBgLayout: getSolidColor(colorBgBase, 0),
+    colorBgSpotlight: getSolidColor(colorBgBase, 26),
+
+    colorBorder: getSolidColor(colorBgBase, 26),
+    colorBorderSecondary: getSolidColor(colorBgBase, 19),
+  }
+}

package/src/theme/themes/dark/index.ts

@@ -0,0 +1,45 @@
+import { generate } from '@ant-design/colors'
+
+import type { DerivativeFunc } from '../../../_util/cssinjs'
+import type { ColorPalettes, MapToken, PresetColorType, SeedToken } from '../../interface'
+import defaultAlgorithm from '../default'
+import { defaultPresetColors } from '../seed'
+import genColorMapToken from '../shared/genColorMapToken'
+import { generateColorPalettes, generateNeutralColorPalettes } from './colors'
+
+const derivative: DerivativeFunc<SeedToken, MapToken> = (token, mapToken) => {
+  const colorPalettes = Object.keys(defaultPresetColors)
+    .map((colorKey: keyof PresetColorType) => {
+      const colors = generate(token[colorKey], { theme: 'dark' })
+
+      return Array.from({ length: 10 })
+        .fill(1)
+        .reduce((prev, _, i) => {
+          prev[`${colorKey}-${i + 1}`] = colors[i]
+          return prev
+        }, {}) as ColorPalettes
+    })
+    .reduce((prev, cur) => {
+      prev = {
+        ...prev,
+        ...cur,
+      }
+      return prev
+    }, {} as ColorPalettes)
+
+  const mergedMapToken = mapToken ?? defaultAlgorithm(token)
+
+  return {
+    ...mergedMapToken,
+
+    // Dark tokens
+    ...colorPalettes,
+    // Colors
+    ...genColorMapToken(token, {
+      generateColorPalettes,
+      generateNeutralColorPalettes,
+    }),
+  }
+}
+
+export default derivative

package/src/theme/themes/default/colorAlgorithm.ts

@@ -0,0 +1,9 @@
+import { TinyColor } from '@ctrl/tinycolor'
+
+export const getAlphaColor = (baseColor: string, alpha: number) =>
+  new TinyColor(baseColor).setAlpha(alpha).toRgbString()
+
+export const getSolidColor = (baseColor: string, brightness: number) => {
+  const instance = new TinyColor(baseColor)
+  return instance.darken(brightness).toHexString()
+}

package/src/theme/themes/default/colors.ts

@@ -0,0 +1,54 @@
+import { generate } from '@ant-design/colors'
+
+import type { GenerateColorMap, GenerateNeutralColorMap } from '../ColorMap'
+import { getAlphaColor, getSolidColor } from './colorAlgorithm'
+
+export const generateColorPalettes: GenerateColorMap = (baseColor: string) => {
+  const colors = generate(baseColor)
+  return {
+    1: colors[0],
+    2: colors[1],
+    3: colors[2],
+    4: colors[3],
+    5: colors[4],
+    6: colors[5],
+    7: colors[6],
+    8: colors[4],
+    9: colors[5],
+    10: colors[6],
+    // 8: colors[7],
+    // 9: colors[8],
+    // 10: colors[9],
+  }
+}
+
+export const generateNeutralColorPalettes: GenerateNeutralColorMap = (
+  bgBaseColor: string,
+  textBaseColor: string,
+) => {
+  const colorBgBase = bgBaseColor || '#fff'
+  const colorTextBase = textBaseColor || '#000'
+
+  return {
+    colorBgBase,
+    colorTextBase,
+
+    colorText: getAlphaColor(colorTextBase, 0.88),
+    colorTextSecondary: getAlphaColor(colorTextBase, 0.65),
+    colorTextTertiary: getAlphaColor(colorTextBase, 0.45),
+    colorTextQuaternary: getAlphaColor(colorTextBase, 0.25),
+
+    colorFill: getAlphaColor(colorTextBase, 0.15),
+    colorFillSecondary: getAlphaColor(colorTextBase, 0.06),
+    colorFillTertiary: getAlphaColor(colorTextBase, 0.04),
+    colorFillQuaternary: getAlphaColor(colorTextBase, 0.02),
+
+    colorBgLayout: getSolidColor(colorBgBase, 4),
+    colorBgContainer: getSolidColor(colorBgBase, 0),
+    colorBgElevated: getSolidColor(colorBgBase, 0),
+    colorBgSpotlight: getAlphaColor(colorTextBase, 0.85),
+
+    colorBorder: getSolidColor(colorBgBase, 15),
+    colorBorderSecondary: getSolidColor(colorBgBase, 6),
+  }
+}

package/src/theme/themes/default/index.ts

@@ -0,0 +1,49 @@
+import { generate } from '@ant-design/colors'
+
+import type { ColorPalettes, MapToken, PresetColorType, SeedToken } from '../../interface'
+import { defaultPresetColors } from '../seed'
+import genColorMapToken from '../shared/genColorMapToken'
+import genCommonMapToken from '../shared/genCommonMapToken'
+import genControlHeight from '../shared/genControlHeight'
+import genFontMapToken from '../shared/genFontMapToken'
+import genSizeMapToken from '../shared/genSizeMapToken'
+import { generateColorPalettes, generateNeutralColorPalettes } from './colors'
+
+export default function derivative(token: SeedToken): MapToken {
+  const colorPalettes = Object.keys(defaultPresetColors)
+    .map((colorKey: keyof PresetColorType) => {
+      const colors = generate(token[colorKey])
+
+      return Array.from({ length: 10 })
+        .fill(1)
+        .reduce((prev, _, i) => {
+          prev[`${colorKey}-${i + 1}`] = colors[i]
+          return prev
+        }, {}) as ColorPalettes
+    })
+    .reduce((prev, cur) => {
+      prev = {
+        ...prev,
+        ...cur,
+      }
+      return prev
+    }, {} as ColorPalettes)
+
+  return {
+    ...token,
+    ...colorPalettes,
+    // Colors
+    ...genColorMapToken(token, {
+      generateColorPalettes,
+      generateNeutralColorPalettes,
+    }),
+    // Font
+    ...genFontMapToken(token.fontSize),
+    // Size
+    ...genSizeMapToken(token),
+    // Height
+    ...genControlHeight(token),
+    // Others
+    ...genCommonMapToken(token),
+  }
+}