@material-ui/core
Version:
React components that implement Google's Material Design.
32 lines (26 loc) • 951 B
TypeScript
import { OverridableStringUnion } from '@material-ui/types';
export type BreakpointDefaults = Record<'xs' | 'sm' | 'md' | 'lg' | 'xl', true>;
export interface BreakpointOverrides {}
export type Breakpoint = OverridableStringUnion<BreakpointDefaults, BreakpointOverrides>;
export type BreakpointValues = { [key in Breakpoint]: number };
export const keys: Breakpoint[];
export interface Breakpoints {
keys: Breakpoint[];
values: BreakpointValues;
up: (key: Breakpoint | number) => string;
down: (key: Breakpoint | number) => string;
between: (start: Breakpoint | number, end: Breakpoint | number) => string;
only: (key: Breakpoint) => string;
/**
* @deprecated
* Use the `values` prop instead
*/
width: (key: Breakpoint) => number;
}
export type BreakpointsOptions = Partial<
{
unit: string;
step: number;
} & Breakpoints
>;
export default function createBreakpoints(options: BreakpointsOptions): Breakpoints;