Page MenuHomec4science
Files F101379455

styleFunctionSx.d.ts
No OneTemporary
Actions

File Metadata

Created
Sun, Feb 9, 21:22

styleFunctionSx.d.ts
View Options

import * as CSS from 'csstype';
import { CSSObject } from '@mui/styled-engine';
import { StandardCSSProperties } from './StandardCssProperties';
import { AliasesCSSProperties } from './AliasesCSSProperties';
import { OverwriteCSSProperties } from './OverwriteCSSProperties';
/**
* The `css` function accepts arrays as values for mobile-first responsive styles.
* Note that this extends to non-theme values also. For example `display=['none', 'block']`
* will also works.
*/
export type ResponsiveStyleValue<T> = T | Array<T | null> | { [key: string]: T | null };
/**
* Map of all CSS pseudo selectors (`:hover`, `:focus`, ...).
*/
export type CSSPseudoSelectorProps<Theme extends object = {}> = {
[K in CSS.Pseudos]?: ((theme: Theme) => SystemStyleObject<Theme>) | SystemStyleObject<Theme>;
};
/**
* Map all nested selectors.
*/
export interface CSSSelectorObject<Theme extends object = {}> {
[cssSelector: string]: ((theme: Theme) => SystemStyleObject<Theme>) | SystemStyleObject<Theme>;
}
type CssVariableType = string | number;
/**
* Map all nested selectors and CSS variables.
*/
export interface CSSSelectorObjectOrCssVariables<Theme extends object = {}> {
[cssSelectorOrVariable: string]:
| ((theme: Theme) => SystemStyleObject<Theme> | string | number)
| SystemStyleObject<Theme>
| CssVariableType;
}
/**
* Map of all available CSS properties (including aliases) and their raw value.
* Only used internally to map CSS properties to input types (responsive value,
* theme function or nested) in `SystemCssProperties`.
*/
export interface AllSystemCSSProperties
extends Omit<StandardCSSProperties, keyof OverwriteCSSProperties>,
OverwriteCSSProperties,
AliasesCSSProperties {}
export type SystemCssProperties<Theme extends object = {}> = {
[K in keyof AllSystemCSSProperties]:
| ResponsiveStyleValue<AllSystemCSSProperties[K]>
| ((theme: Theme) => ResponsiveStyleValue<AllSystemCSSProperties[K]>)
| SystemStyleObject<Theme>;
};
/**
* The `SystemStyleObject` defines custom properties that will be transformed to
* their corresponding values from the `Theme`. Other valid CSS properties are also allowed.
*/
export type SystemStyleObject<Theme extends object = {}> =
| SystemCssProperties<Theme>
| CSSPseudoSelectorProps<Theme>
| CSSSelectorObjectOrCssVariables<Theme>
| null;
/**
* The `SxProps` can be either object or function
*/
export type SxProps<Theme extends object = {}> =
| SystemStyleObject<Theme>
| ((theme: Theme) => SystemStyleObject<Theme>)
| ReadonlyArray<
boolean | SystemStyleObject<Theme> | ((theme: Theme) => SystemStyleObject<Theme>)
>;
export interface StyleFunctionSx {
(props: object): CSSObject;
filterProps?: string[];
}
// eslint-disable-next-line @typescript-eslint/naming-convention
export function unstable_createStyleFunctionSx(
styleFunctionMapping: Record<string, StyleFunctionSx>,
): StyleFunctionSx;
declare const styleFunctionSx: StyleFunctionSx;
export default styleFunctionSx;

Event Timeline

c4science · Help