diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts index b6d19844..62a54085 100644 --- a/packages/core/src/types.ts +++ b/packages/core/src/types.ts @@ -4,22 +4,40 @@ interface Frames { }; } +/** + * Hex Colors in string Formate. + * + * `Example: `"#FFFFFF" + */ +type HexColor = string; + +/** + * @Colors expect `base`, `outline` & `watch-background` colors in **HexColor** Format. + * @default background is `base` color. + */ type Colors = { - base: string; - outline: string; + base: HexColor; + outline: HexColor; watch?: { - background: string; + background: HexColor; }; }; +/** + * Colors object for this cursors theme. + * + * @example + * ```typescript + * const themeColors: ThemeColors = { + * White:{ + * base: "#FFFFFF", + * outline: "#000000" + * }, + * }; + * ``` + */ interface ThemeColors { [themeName: string]: Colors; } -interface PixelDiffRate { - [name: string]: { - rate: number; - }; -} - -export { Frames, Colors, ThemeColors, PixelDiffRate }; +export { Frames, Colors, ThemeColors };