@types/react-responsive

Version 8.0.8
Published 1 year ago
6.08 kB
1 dependency
MIT license

Install

npm i @types/react-responsive

yarn add @types/react-responsive

pnpm add @types/react-responsive

Overview

TypeScript definitions for react-responsive

Variables

variable Context

const Context: React.Context<Partial<MediaQueryAllQueryable>>;

Functions

function toQuery

toQuery: (matchers: Partial<MediaQueryAllQueryable>) => string;

function useMediaQuery

useMediaQuery: (
    settings: Partial<MediaQueryAllQueryable & { query?: string | undefined }>,
    device?: MediaQueryMatchers,
    callback?: (matches: boolean) => void
) => boolean;

Classes

class MediaQuery

class MediaQuery extends React.Component<MediaQueryProps> {}

Interfaces

interface MediaQueryAllQueryable

interface MediaQueryAllQueryable extends MediaQueryFeatures, MediaQueryTypes {}

interface MediaQueryFeatures

interface MediaQueryFeatures extends MediaQueryMatchers {}

property maxAspectRatio

maxAspectRatio?: string | undefined;

property maxColor

maxColor?: number | undefined;

property maxColorIndex

maxColorIndex?: number | undefined;

property maxDeviceAspectRatio

maxDeviceAspectRatio?: string | undefined;

property maxDeviceHeight

maxDeviceHeight?: number | string | undefined;

property maxDeviceWidth

maxDeviceWidth?: number | string | undefined;

property maxHeight

maxHeight?: number | string | undefined;

property maxMonochrome

maxMonochrome?: number | undefined;

property maxResolution

maxResolution?: number | string | undefined;

property maxWidth

maxWidth?: number | string | undefined;

property minAspectRatio

minAspectRatio?: string | undefined;

property minColor

minColor?: number | undefined;

property minColorIndex

minColorIndex?: number | undefined;

property minDeviceAspectRatio

minDeviceAspectRatio?: string | undefined;

property minDeviceHeight

minDeviceHeight?: number | string | undefined;

property minDeviceWidth

minDeviceWidth?: number | string | undefined;

property minHeight

minHeight?: number | string | undefined;

property minMonochrome

minMonochrome?: number | undefined;

property minResolution

minResolution?: number | string | undefined;

property minWidth

minWidth?: number | string | undefined;

interface MediaQueryMatchers

interface MediaQueryMatchers {}

property aspectRatio

aspectRatio?: string | undefined;

property color

color?: boolean | undefined;

property colorIndex

colorIndex?: boolean | undefined;

property deviceAspectRatio

deviceAspectRatio?: string | undefined;

property deviceHeight

deviceHeight?: number | string | undefined;

property deviceWidth

deviceWidth?: number | string | undefined;

property height

height?: number | string | undefined;

property monochrome

monochrome?: boolean | undefined;

property orientation

orientation?: 'portrait' | 'landscape' | undefined;

property resolution

resolution?: number | string | undefined;

property scan

scan?: 'progressive' | 'interlace' | undefined;

property type

type?: MediaQueryType | undefined;

property width

width?: number | string | undefined;

interface MediaQueryProps

interface MediaQueryProps extends MediaQueryAllQueryable {}

property children

children?: React.ReactNode | ((matches: boolean) => React.ReactNode) | undefined;

property className

className?: string | undefined;

property component

component?: React.ElementType | undefined;

property device

device?: MediaQueryMatchers | undefined;

property onBeforeChange

onBeforeChange?: ((matches: boolean) => void) | undefined;

property onChange

onChange?: ((matches: boolean) => void) | undefined;

property query

query?: string | undefined;

property style

style?: React.CSSProperties | undefined;

property values

values?: Partial<MediaQueryMatchers> | undefined;

interface MediaQueryTypes

interface MediaQueryTypes {}

property all

all?: boolean | undefined;

property aural

aural?: boolean | undefined;

property braille

braille?: boolean | undefined;

property embossed

embossed?: boolean | undefined;

property grid

grid?: boolean | undefined;

property handheld

handheld?: boolean | undefined;

property print

print?: boolean | undefined;

property projection

projection?: boolean | undefined;

property screen

screen?: boolean | undefined;

property tty

tty?: boolean | undefined;

property tv

tv?: boolean | undefined;

Type Aliases

type MediaQueryType

type MediaQueryType = keyof MediaQueryTypes;

Package Files (1)

index.d.ts

Dependencies (1)

@types/react

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-responsive.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-responsive)

HTML

<a href="https://www.jsdocs.io/package/@types/react-responsive"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 year ago.
Package analyzed in 2036 ms.
Missing or incorrect documentation? Open an issue for this package.