📚 Types Docs

This commit is contained in:
ful1e5 2020-10-01 17:49:25 +05:30
parent 74440e9794
commit 15a9bd71dc

View file

@ -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 };