Blame view

天文台pc/tianwentai-ui/node_modules/@mui/system/createBreakpoints/createBreakpoints.d.ts 3.72 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
  import { OverridableStringUnion } from '@mui/types';
  export interface BreakpointOverrides {}
  export type Breakpoint = OverridableStringUnion<'xs' | 'sm' | 'md' | 'lg' | 'xl', BreakpointOverrides>;
  export const keys: Breakpoint[];
  
  // Keep in sync with docs/src/pages/customization/breakpoints/breakpoints.md
  // #host-reference
  export interface Breakpoints {
    keys: Breakpoint[];
    /**
     * Each breakpoint (a key) matches with a fixed screen width (a value).
     * @default {
     *    // extra-small
     *    xs: 0,
     *    // small
     *    sm: 600,
     *    // medium
     *    md: 900,
     *    // large
     *    lg: 1200,
     *    // extra-large
     *    xl: 1536,
     * }
     */
    values: { [key in Breakpoint]: number };
    /**
     * @param key - A breakpoint key (`xs`, `sm`, etc.) or a screen width number in px.
     * @returns A media query string ready to be used with most styling solutions, which matches screen widths greater than the screen size given by the breakpoint key (inclusive).
     * @see [API documentation](https://mui.com/material-ui/customization/breakpoints/#theme-breakpoints-up-key-media-query)
     */
    up: (key: Breakpoint | number) => string;
    /**
     * @param key - A breakpoint key (`xs`, `sm`, etc.) or a screen width number in px.
     * @returns A media query string ready to be used with most styling solutions, which matches screen widths less than the screen size given by the breakpoint key (exclusive).
     * @see [API documentation](https://mui.com/material-ui/customization/breakpoints/#theme-breakpoints-down-key-media-query)
     */
    down: (key: Breakpoint | number) => string;
    /**
     * @param start - A breakpoint key (`xs`, `sm`, etc.) or a screen width number in px.
     * @param end - A breakpoint key (`xs`, `sm`, etc.) or a screen width number in px.
     * @returns A media query string ready to be used with most styling solutions, which matches screen widths greater than
     *          the screen size given by the breakpoint key in the first argument (inclusive) and less than the screen size given by the breakpoint key in the second argument (exclusive).
     * @see [API documentation](https://mui.com/material-ui/customization/breakpoints/#theme-breakpoints-between-start-end-media-query)
     */
    between: (start: Breakpoint | number, end: Breakpoint | number) => string;
    /**
     * @param key - A breakpoint key (`xs`, `sm`, etc.) or a screen width number in px.
     * @returns A media query string ready to be used with most styling solutions, which matches screen widths starting from
     *          the screen size given by the breakpoint key (inclusive) and stopping at the screen size given by the next breakpoint key (exclusive).
     * @see [API documentation](https://mui.com/material-ui/customization/breakpoints/#theme-breakpoints-only-key-media-query)
     */
    only: (key: Breakpoint) => string;
    /**
     * @param key - A breakpoint key (`xs`, `sm`, etc.).
     * @returns A media query string ready to be used with most styling solutions, which matches screen widths stopping at
     *          the screen size given by the breakpoint key (exclusive) and starting at the screen size given by the next breakpoint key (inclusive).
     */
    not: (key: Breakpoint) => string;
    /**
     * The unit used for the breakpoint's values.
     * @default 'px'
     */
    unit?: string | undefined;
  }
  export interface BreakpointsOptions extends Partial<Breakpoints> {
    /**
     * The increment divided by 100 used to implement exclusive breakpoints.
     * For example, `step: 5` means that `down(500)` will result in `'(max-width: 499.95px)'`.
     * @default 5
     */
    step?: number | undefined;
    /**
     * The unit used for the breakpoint's values.
     * @default 'px'
     */
    unit?: string | undefined;
  }
  export default function createBreakpoints(options: BreakpointsOptions): Breakpoints;