|
| 1 | +# Sistent Theme Palette |
| 2 | + |
| 3 | +This document provides an overview of the custom palette used for theme components. |
| 4 | + |
| 5 | +## Palette Options |
| 6 | + |
| 7 | +### Interactiveness |
| 8 | + |
| 9 | +Defines the interaction color options used in the palette. |
| 10 | + |
| 11 | +- `default`: Default interaction color. |
| 12 | +- `hover`: Color on hover. |
| 13 | +- `disabled`: Color when disabled (optional). |
| 14 | +- `pressed`: Color when pressed. |
| 15 | +- `secondary`: Secondary interaction color. |
| 16 | +- `tertiary`: Tertiary interaction color. |
| 17 | + |
| 18 | +### TypeBackground |
| 19 | + |
| 20 | +Defines the extended background color options used in the palette. |
| 21 | + |
| 22 | +- `secondary`: Secondary background color. |
| 23 | +- `graphics`: Graphics background color. |
| 24 | +- `tertiary`: Tertiary background color. |
| 25 | +- `hover`: Hover background color. |
| 26 | +- `blur`: Blur effect colors (heavy and light). |
| 27 | +- `brand`: Brand interaction colors. |
| 28 | +- `cta`: Call to action interaction colors. |
| 29 | +- `info`: Information interaction colors. |
| 30 | +- `success`: Success interaction colors. |
| 31 | +- `warning`: Warning interaction colors. |
| 32 | +- `error`: Error interaction colors. |
| 33 | +- `code`: Code background color. |
| 34 | + |
| 35 | +To add a new background color, add a new key to the `TypeBackground` type and update the `background` property in the `PaletteColor` type. |
| 36 | + |
| 37 | +### TypeText |
| 38 | + |
| 39 | +Defines the extended text color options used in the palette. |
| 40 | + |
| 41 | +- `default`: Default text color. |
| 42 | +- `secondary`: Secondary text color. |
| 43 | +- `tertiary`: Tertiary text color. |
| 44 | +- `inverse`: Inverse text color. |
| 45 | +- `brand`: Brand text color. |
| 46 | +- `info`: Information text color. |
| 47 | +- `success`: Success text color. |
| 48 | +- `warning`: Warning text color. |
| 49 | +- `error`: Error text color. |
| 50 | + |
| 51 | +To add a new text color, add a new key to the `TypeText` type and update the `text` property in the `PaletteColor` type. |
| 52 | + |
| 53 | +### PaletteColor |
| 54 | + |
| 55 | +Defines the color options for the palette. |
| 56 | + |
| 57 | +### SimplePaletteColorOptions |
| 58 | + |
| 59 | +Defines the simple palette color options. |
| 60 | + |
| 61 | +## Palette Configuration |
| 62 | + |
| 63 | +The palette configuration includes the following sections: |
| 64 | + |
| 65 | +### lightModePalette |
| 66 | + |
| 67 | +Defines the palette options for the light mode. |
| 68 | + |
| 69 | +### darkModePalette |
| 70 | + |
| 71 | +Defines the palette options for the dark mode. |
| 72 | + |
| 73 | +## Color Definitions |
| 74 | + |
| 75 | +The color definitions are imported from the `./colors` module and include various shades and hues used throughout the palette. |
0 commit comments