mirror of
https://github.com/ful1e5/Bibata_Cursor.git
synced 2025-05-28 22:14:21 -04:00
📚 Types Docs
This commit is contained in:
parent
74440e9794
commit
15a9bd71dc
1 changed files with 28 additions and 10 deletions
|
@ -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 };
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue