diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..68c537d --- /dev/null +++ b/index.d.ts @@ -0,0 +1,143 @@ +/** + * Catppuccin variants + */ +export namespace variants { + /** + * Light variant + */ + const latte: Labels + + /** + * Low-saturation, low-contrast dark variant + */ + const frappe: Labels + + /** + * Mid-saturation, mid-contrast dark variant + */ + const macchiato: Labels + + /** + * High-saturation, High-contrast dark variant + */ + const mocha: Labels +} + +/** + * Palette labels + */ +export namespace labels { + const rosewater: Variants + const flamingo: Variants + const pink: Variants + const mauve: Variants + const red: Variants + const maroon: Variants + const peach: Variants + const yellow: Variants + const green: Variants + const teal: Variants + const sky: Variants + const sapphire: Variants + const blue: Variants + const lavender: Variants + + const surface2: Variants + const subtext0: Variants + const subtext1: Variants + const overlay0: Variants + const overlay2: Variants + const surface0: Variants + const text: Variants + const overlay1: Variants + const surface1: Variants + + const base: Variants + const mantle: Variants + const crust: Variants +} +export default palette + +export interface Color { + /** + * Formatted hex value + * @example #babbf1 + */ + hex: string + /** + * Formatted rgb value + * @example rgb(186, 187, 241) + */ + rgb: string + /** + * Formatted hsl value + * @example hsl(239, 66%, 84%) + */ + hsl: string +} + +export interface AlphaColor extends Color { + alpha: Color +} + +export interface Labels { + + rosewater: T + flamingo: T + pink: T + mauve: T + red: T + maroon: T + peach: T + yellow: T + green: T + teal: T + sky: T + sapphire: T + blue: T + lavender: T + + text: U + subtext1: U + subtext0: U + overlay2: U + overlay1: U + overlay0: U + surface2: U + surface1: U + surface0: U + + base: U + mantle: U + crust: U +} + +export interface Variants { + /** + * Light variant + */ + latte: T + /** + * Low-saturation, low-contrast dark variant + */ + frappe: T + /** + * Mid-saturation, mid-contrast dark variant + */ + macchiato: T + /** + * High-saturation, High-contrast dark variant + */ + mocha: T +} + +declare namespace palette { + /** + * Palette variants + */ + const variants: Variants> + /** + * Palette labels + */ + const labels: Labels, Variants> +} diff --git a/package.json b/package.json index b52a0ec..a9b6fdc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@catppuccin/palette", - "version": "0.1.1", + "version": "0.1.2", "description": "Soothing pastel themes for the high-spirited!", "main": "index.js", "type": "module", @@ -10,8 +10,10 @@ }, "files": [ "css/", - "index.js" + "index.js", + "index.d.ts" ], + "types": "index.d.ts", "repository": { "type": "git", "url": "git+https://github.com/catppuccin/palette.git"