jsx-email
Version:
Render JSX email components to HTML email
37 lines • 1.37 kB
TypeScript
import type { JsxEmailComponent } from '../types.js';
export type ColorSchemeMode = 'dark'
/**
* The email client will only ever render the content in the dark color scheme and forbids the
* email client from overriding the color scheme.
*/
| 'dark only' | 'light'
/**
* The email client will choose the light or dark theme to match the user’s preference.
* If the user’s preference does not match something in the list, the email client will choose
* which mode to display.
*/
| 'light dark'
/**
* The email client will choose the first of the listed schemes that it supports taking user
* preference into account and forbids the email client from overriding the color scheme.
*/
| 'light dark only'
/**
* The email client will only ever render the content in the light color scheme and forbids the
* email client from overriding the color scheme.
*/
| 'light only'
/**
* Indicates that the email supports the page’s supported color schemes, if they are set, or
* that it supports no color schemes at all otherwise.
*/
| 'normal';
export interface ColorSchemeProps {
/**
* Selects the color scheme mode that informs the email client which mode to render.
* @default `normal`
*/
mode?: ColorSchemeMode;
}
export declare const ColorScheme: JsxEmailComponent<ColorSchemeProps>;
//# sourceMappingURL=color-scheme.d.ts.map