UNPKG

951 BTypeScriptView Raw
1import { OverridableStringUnion } from '@material-ui/types';
2
3export type BreakpointDefaults = Record<'xs' | 'sm' | 'md' | 'lg' | 'xl', true>;
4export interface BreakpointOverrides {}
5
6export type Breakpoint = OverridableStringUnion<BreakpointDefaults, BreakpointOverrides>;
7export type BreakpointValues = { [key in Breakpoint]: number };
8export const keys: Breakpoint[];
9
10export interface Breakpoints {
11 keys: Breakpoint[];
12 values: BreakpointValues;
13 up: (key: Breakpoint | number) => string;
14 down: (key: Breakpoint | number) => string;
15 between: (start: Breakpoint | number, end: Breakpoint | number) => string;
16 only: (key: Breakpoint) => string;
17 /**
18 * @deprecated
19 * Use the `values` prop instead
20 */
21 width: (key: Breakpoint) => number;
22}
23
24export type BreakpointsOptions = Partial<
25 {
26 unit: string;
27 step: number;
28 } & Breakpoints
29>;
30
31export default function createBreakpoints(options: BreakpointsOptions): Breakpoints;