kotlin-mui-system/mui.system/UseMediaQueryOptions

UseMediaQueryOptions

external interface UseMediaQueryOptions(source)

Properties

defaultMatches

abstract var defaultMatches: Boolean?

As window.matchMedia() is unavailable on the server, it returns a default matches during the first mount.

matchMedia

abstract var matchMedia: (query: String) -> MediaQueryList?

You can provide your own implementation of matchMedia. This can be used for handling an iframe content window.

noSsr

abstract var noSsr: Boolean?

To perform the server-side hydration, the hook needs to render twice. A first time with defaultMatches, the value of the server, and a second time with the resolved value. This double pass rendering cycle comes with a drawback: it's slower. You can set this option to true if you use the returned value only client-side.

ssrMatchMedia

abstract var ssrMatchMedia: (query: String) -> dynamic?

You can provide your own implementation of matchMedia, it's used when rendering server-side.