kotlin-mui-system/mui.system

Package-level declarations

Types

BoxClasses

sealed external interface BoxClasses

BoxOwnProps

external interface BoxOwnProps : PropsWithChildren, PropsWithSx

BoxProps

external interface BoxProps : BoxOwnProps, HTMLAttributes<HTMLDivElement> , PropsWithComponent

Breakpoint

sealed external interface Breakpoint

Breakpoints

external interface Breakpoints

BreakpointsOptions

external interface BreakpointsOptions

ContainerClasses

sealed external interface ContainerClasses

ContainerProps

external interface ContainerProps : HTMLAttributes<HTMLDivElement> , PropsWithChildren, PropsWithSx

CustomSystemProps

external interface CustomSystemProps : Props

Direction

sealed external interface Direction

GlobalStylesProps

external interface GlobalStylesProps : Props

InitColorSchemeScriptProps

external interface InitColorSchemeScriptProps : Props

PropsWithSx

external interface PropsWithSx : Props

ResponsiveStyleValue

external interface ResponsiveStyleValue<T : Any>

Shape

external interface Shape

ShapeOptions

typealias ShapeOptions = Shape

Spacing

sealed interface Spacing

SpacingArgument

typealias SpacingArgument = Int

SpacingOptions

sealed external interface SpacingOptions

StackBaseProps

external interface StackBaseProps : PropsWithChildren

StackClasses

sealed external interface StackClasses

StackDirection

sealed external interface StackDirection

StackOwnerState

external interface StackOwnerState

StackProps

external interface StackProps : StackBaseProps, PropsWithSx

StandardProps

external interface StandardProps : PropsWithStyle, PropsWithClassName

SxProps

typealias SxProps<T> = CSSProperties

Theme

external interface Theme

ThemeOptions

external interface ThemeOptions

ThemeProviderProps

external interface ThemeProviderProps : PropsWithChildren

Union

typealias Union = String

UseMediaQueryOptions

external interface UseMediaQueryOptions

Properties

Box

external val Box: FC<BoxProps>

Demos:

boxClasses

external val boxClasses: BoxClasses

Container

external val Container: FC<ContainerProps>

Demos:

containerClasses

external val containerClasses: ContainerClasses

Stack

external val Stack: FC<StackProps>

Demos:

stackClasses

external val stackClasses: StackClasses

ThemeProvider

external val ThemeProvider: FC<ThemeProviderProps>

This component makes the theme available down the React tree. It should preferably be used at the root of your component tree. API:

Functions

createBreakpoints

external fun createBreakpoints(options: BreakpointsOptions): Breakpoints

createSpacing

external fun createSpacing(spacingInput: SpacingOptions? = definedExternally): Spacing

createTheme

external fun createTheme(options: ThemeOptions? = definedExternally, vararg args: Any): Theme

responsive

inline fun <T : Any> responsive(value: T): ResponsiveStyleValue<T>

fun <T : Any, R : T, ResponsiveStyleValue<T>> responsive(vararg values: Pair<Breakpoint, T>): R

SpacingOptions

inline fun SpacingOptions(value: ReadonlyArray<Int>): SpacingOptions

inline fun SpacingOptions(noinline value: (abs: Int) -> Length): SpacingOptions

inline fun SpacingOptions(noinline value: (abs: Length) -> Length): SpacingOptions

inline fun SpacingOptions(value: Int): SpacingOptions

inline fun SpacingOptions(value: Spacing): SpacingOptions

inline fun PropsWithSx.sx(crossinline block: PropertiesBuilder.() -> Unit)

useMediaQuery

external fun <Theme : Any> useMediaQuery(queryInput: (theme: Theme) -> String, options: UseMediaQueryOptions? = definedExternally): Boolean

external fun useMediaQuery(queryInput: String, options: UseMediaQueryOptions? = definedExternally): Boolean

useTheme

external fun <T : Theme> useTheme(defaultTheme: T? = definedExternally): T