@instructure/ui-responsive 8.8.1-snapshot.3 → 8.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/es/Responsive/index.js +4 -11
- package/es/Responsive/props.js +34 -0
- package/lib/Responsive/index.js +4 -14
- package/lib/Responsive/props.js +46 -0
- package/package.json +12 -13
- package/src/Responsive/index.tsx +5 -12
- package/src/Responsive/{types.ts → props.ts} +37 -4
- package/src/index.ts +1 -1
- package/types/Responsive/index.d.ts +15 -14
- package/types/Responsive/index.d.ts.map +1 -1
- package/types/Responsive/{types.d.ts → props.d.ts} +13 -5
- package/types/Responsive/props.d.ts.map +1 -0
- package/types/index.d.ts +1 -1
- package/LICENSE.md +0 -27
- package/es/Responsive/types.js +0 -1
- package/lib/Responsive/types.js +0 -1
- package/types/Responsive/types.d.ts.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
- fix shared-types TS errors ([7b83164](https://github.com/instructure/instructure-ui/commit/7b83164f4c5872f3a217e010563f59bf584ae4fc))
|
|
11
|
+
|
|
6
12
|
# [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
|
|
7
13
|
|
|
8
14
|
**Note:** Version bump only for package @instructure/ui-responsive
|
package/es/Responsive/index.js
CHANGED
|
@@ -22,20 +22,19 @@
|
|
|
22
22
|
* SOFTWARE.
|
|
23
23
|
*/
|
|
24
24
|
import React, { Component } from 'react';
|
|
25
|
-
import PropTypes from 'prop-types';
|
|
26
25
|
import { deepEqual } from '@instructure/ui-utils';
|
|
27
26
|
import { logError as error } from '@instructure/console';
|
|
28
27
|
import { addElementQueryMatchListener, updateElementMatches } from '../addElementQueryMatchListener';
|
|
29
28
|
import { addMediaQueryMatchListener } from '../addMediaQueryMatchListener';
|
|
30
|
-
import { ResponsivePropTypes } from '../ResponsivePropTypes';
|
|
31
29
|
import { findDOMNode } from '@instructure/ui-dom-utils';
|
|
32
|
-
|
|
30
|
+
import { allowedProps, propTypes } from './props';
|
|
33
31
|
/**
|
|
34
32
|
---
|
|
35
33
|
category: components
|
|
36
34
|
---
|
|
37
35
|
@tsProps
|
|
38
36
|
**/
|
|
37
|
+
|
|
39
38
|
class Responsive extends Component {
|
|
40
39
|
constructor(...args) {
|
|
41
40
|
super(...args);
|
|
@@ -148,16 +147,10 @@ class Responsive extends Component {
|
|
|
148
147
|
}
|
|
149
148
|
|
|
150
149
|
Responsive.displayName = "Responsive";
|
|
151
|
-
Responsive.
|
|
152
|
-
|
|
153
|
-
query: PropTypes.objectOf(ResponsivePropTypes.validQuery).isRequired,
|
|
154
|
-
props: PropTypes.objectOf(PropTypes.object),
|
|
155
|
-
render: PropTypes.func,
|
|
156
|
-
children: PropTypes.func
|
|
157
|
-
};
|
|
150
|
+
Responsive.allowedProps = allowedProps;
|
|
151
|
+
Responsive.propTypes = propTypes;
|
|
158
152
|
Responsive.defaultProps = {
|
|
159
153
|
children: null,
|
|
160
|
-
render: void 0,
|
|
161
154
|
match: 'element',
|
|
162
155
|
props: null
|
|
163
156
|
};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* The MIT License (MIT)
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) 2015 - present Instructure, Inc.
|
|
5
|
+
*
|
|
6
|
+
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
* of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
* in the Software without restriction, including without limitation the rights
|
|
9
|
+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
* copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
* furnished to do so, subject to the following conditions:
|
|
12
|
+
*
|
|
13
|
+
* The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
* copies or substantial portions of the Software.
|
|
15
|
+
*
|
|
16
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
* SOFTWARE.
|
|
23
|
+
*/
|
|
24
|
+
import PropTypes from 'prop-types';
|
|
25
|
+
import { ResponsivePropTypes } from '../ResponsivePropTypes';
|
|
26
|
+
const propTypes = {
|
|
27
|
+
match: PropTypes.oneOf(['element', 'media']),
|
|
28
|
+
query: PropTypes.objectOf(ResponsivePropTypes.validQuery).isRequired,
|
|
29
|
+
props: PropTypes.objectOf(PropTypes.object),
|
|
30
|
+
render: PropTypes.func,
|
|
31
|
+
children: PropTypes.func
|
|
32
|
+
};
|
|
33
|
+
const allowedProps = ['match', 'query', 'props', 'render', 'children'];
|
|
34
|
+
export { propTypes, allowedProps };
|
package/lib/Responsive/index.js
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
|
|
4
|
-
|
|
5
3
|
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
|
|
6
4
|
|
|
7
5
|
Object.defineProperty(exports, "__esModule", {
|
|
@@ -11,8 +9,6 @@ exports.Responsive = exports.default = void 0;
|
|
|
11
9
|
|
|
12
10
|
var _react = _interopRequireWildcard(require("react"));
|
|
13
11
|
|
|
14
|
-
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
15
|
-
|
|
16
12
|
var _deepEqual = require("@instructure/ui-utils/lib/deepEqual.js");
|
|
17
13
|
|
|
18
14
|
var _console = require("@instructure/console");
|
|
@@ -21,10 +17,10 @@ var _addElementQueryMatchListener = require("../addElementQueryMatchListener");
|
|
|
21
17
|
|
|
22
18
|
var _addMediaQueryMatchListener = require("../addMediaQueryMatchListener");
|
|
23
19
|
|
|
24
|
-
var _ResponsivePropTypes = require("../ResponsivePropTypes");
|
|
25
|
-
|
|
26
20
|
var _findDOMNode = require("@instructure/ui-dom-utils/lib/findDOMNode.js");
|
|
27
21
|
|
|
22
|
+
var _props = require("./props");
|
|
23
|
+
|
|
28
24
|
/*
|
|
29
25
|
* The MIT License (MIT)
|
|
30
26
|
*
|
|
@@ -168,16 +164,10 @@ class Responsive extends _react.Component {
|
|
|
168
164
|
|
|
169
165
|
exports.Responsive = Responsive;
|
|
170
166
|
Responsive.displayName = "Responsive";
|
|
171
|
-
Responsive.
|
|
172
|
-
|
|
173
|
-
query: _propTypes.default.objectOf(_ResponsivePropTypes.ResponsivePropTypes.validQuery).isRequired,
|
|
174
|
-
props: _propTypes.default.objectOf(_propTypes.default.object),
|
|
175
|
-
render: _propTypes.default.func,
|
|
176
|
-
children: _propTypes.default.func
|
|
177
|
-
};
|
|
167
|
+
Responsive.allowedProps = _props.allowedProps;
|
|
168
|
+
Responsive.propTypes = _props.propTypes;
|
|
178
169
|
Responsive.defaultProps = {
|
|
179
170
|
children: null,
|
|
180
|
-
render: void 0,
|
|
181
171
|
match: 'element',
|
|
182
172
|
props: null
|
|
183
173
|
};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
|
|
4
|
+
|
|
5
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.allowedProps = exports.propTypes = void 0;
|
|
9
|
+
|
|
10
|
+
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
11
|
+
|
|
12
|
+
var _ResponsivePropTypes = require("../ResponsivePropTypes");
|
|
13
|
+
|
|
14
|
+
/*
|
|
15
|
+
* The MIT License (MIT)
|
|
16
|
+
*
|
|
17
|
+
* Copyright (c) 2015 - present Instructure, Inc.
|
|
18
|
+
*
|
|
19
|
+
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
20
|
+
* of this software and associated documentation files (the "Software"), to deal
|
|
21
|
+
* in the Software without restriction, including without limitation the rights
|
|
22
|
+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
23
|
+
* copies of the Software, and to permit persons to whom the Software is
|
|
24
|
+
* furnished to do so, subject to the following conditions:
|
|
25
|
+
*
|
|
26
|
+
* The above copyright notice and this permission notice shall be included in all
|
|
27
|
+
* copies or substantial portions of the Software.
|
|
28
|
+
*
|
|
29
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
30
|
+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
31
|
+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
32
|
+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
33
|
+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
34
|
+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
35
|
+
* SOFTWARE.
|
|
36
|
+
*/
|
|
37
|
+
const propTypes = {
|
|
38
|
+
match: _propTypes.default.oneOf(['element', 'media']),
|
|
39
|
+
query: _propTypes.default.objectOf(_ResponsivePropTypes.ResponsivePropTypes.validQuery).isRequired,
|
|
40
|
+
props: _propTypes.default.objectOf(_propTypes.default.object),
|
|
41
|
+
render: _propTypes.default.func,
|
|
42
|
+
children: _propTypes.default.func
|
|
43
|
+
};
|
|
44
|
+
exports.propTypes = propTypes;
|
|
45
|
+
const allowedProps = ['match', 'query', 'props', 'render', 'children'];
|
|
46
|
+
exports.allowedProps = allowedProps;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-responsive",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.9.0",
|
|
4
4
|
"description": "A component that allows for rendering a component differently based on either the element or the viewport size",
|
|
5
5
|
"author": "Instructure, Inc. Engineering and Product Design",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -25,19 +25,19 @@
|
|
|
25
25
|
"license": "MIT",
|
|
26
26
|
"dependencies": {
|
|
27
27
|
"@babel/runtime": "^7.13.10",
|
|
28
|
-
"@instructure/console": "8.
|
|
29
|
-
"@instructure/debounce": "8.
|
|
30
|
-
"@instructure/
|
|
31
|
-
"@instructure/ui-
|
|
32
|
-
"@instructure/ui-
|
|
33
|
-
"@instructure/ui-
|
|
28
|
+
"@instructure/console": "8.9.0",
|
|
29
|
+
"@instructure/debounce": "8.9.0",
|
|
30
|
+
"@instructure/shared-types": "8.9.0",
|
|
31
|
+
"@instructure/ui-dom-utils": "8.9.0",
|
|
32
|
+
"@instructure/ui-react-utils": "8.9.0",
|
|
33
|
+
"@instructure/ui-testable": "8.9.0",
|
|
34
|
+
"@instructure/ui-utils": "8.9.0",
|
|
34
35
|
"prop-types": "^15"
|
|
35
36
|
},
|
|
36
37
|
"devDependencies": {
|
|
37
|
-
"@instructure/
|
|
38
|
-
"@instructure/ui-
|
|
39
|
-
"@instructure/ui-
|
|
40
|
-
"@instructure/ui-test-utils": "8.8.1-snapshot.3+d5d6d4cd8"
|
|
38
|
+
"@instructure/ui-babel-preset": "8.9.0",
|
|
39
|
+
"@instructure/ui-color-utils": "8.9.0",
|
|
40
|
+
"@instructure/ui-test-utils": "8.9.0"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
43
|
"react": ">=16.8 <=17"
|
|
@@ -45,6 +45,5 @@
|
|
|
45
45
|
"publishConfig": {
|
|
46
46
|
"access": "public"
|
|
47
47
|
},
|
|
48
|
-
"sideEffects": false
|
|
49
|
-
"gitHead": "d5d6d4cd8f300e8635c69248f5d794c002269e08"
|
|
48
|
+
"sideEffects": false
|
|
50
49
|
}
|
package/src/Responsive/index.tsx
CHANGED
|
@@ -23,7 +23,6 @@
|
|
|
23
23
|
*/
|
|
24
24
|
|
|
25
25
|
import React, { Component } from 'react'
|
|
26
|
-
import PropTypes from 'prop-types'
|
|
27
26
|
|
|
28
27
|
import { deepEqual } from '@instructure/ui-utils'
|
|
29
28
|
import { logError as error } from '@instructure/console'
|
|
@@ -33,14 +32,14 @@ import {
|
|
|
33
32
|
updateElementMatches
|
|
34
33
|
} from '../addElementQueryMatchListener'
|
|
35
34
|
import { addMediaQueryMatchListener } from '../addMediaQueryMatchListener'
|
|
36
|
-
import { ResponsivePropTypes } from '../ResponsivePropTypes'
|
|
37
35
|
import { BreakpointQueries, QueriesMatching, UpdateMatches } from '../QueryType'
|
|
38
36
|
import { findDOMNode } from '@instructure/ui-dom-utils'
|
|
39
|
-
import {
|
|
37
|
+
import type {
|
|
40
38
|
ResponsiveByBreakpointProps,
|
|
41
39
|
ResponsiveProps,
|
|
42
40
|
ResponsivePropsObject
|
|
43
|
-
} from './
|
|
41
|
+
} from './props'
|
|
42
|
+
import { allowedProps, propTypes } from './props'
|
|
44
43
|
|
|
45
44
|
/**
|
|
46
45
|
---
|
|
@@ -49,17 +48,11 @@ category: components
|
|
|
49
48
|
@tsProps
|
|
50
49
|
**/
|
|
51
50
|
class Responsive extends Component<ResponsiveProps> {
|
|
52
|
-
static
|
|
53
|
-
|
|
54
|
-
query: PropTypes.objectOf(ResponsivePropTypes.validQuery).isRequired,
|
|
55
|
-
props: PropTypes.objectOf(PropTypes.object),
|
|
56
|
-
render: PropTypes.func,
|
|
57
|
-
children: PropTypes.func
|
|
58
|
-
}
|
|
51
|
+
static allowedProps = allowedProps
|
|
52
|
+
static propTypes = propTypes
|
|
59
53
|
|
|
60
54
|
static defaultProps = {
|
|
61
55
|
children: null,
|
|
62
|
-
render: undefined,
|
|
63
56
|
match: 'element',
|
|
64
57
|
props: null
|
|
65
58
|
}
|
|
@@ -22,20 +22,24 @@
|
|
|
22
22
|
* SOFTWARE.
|
|
23
23
|
*/
|
|
24
24
|
|
|
25
|
-
import
|
|
25
|
+
import PropTypes from 'prop-types'
|
|
26
|
+
import { ResponsivePropTypes } from '../ResponsivePropTypes'
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
import type { PropValidators } from '@instructure/shared-types'
|
|
29
|
+
import type { BreakpointQueries, QueriesMatching } from '../QueryType'
|
|
30
|
+
|
|
31
|
+
interface ResponsivePropsObject {
|
|
28
32
|
[propName: string]: any
|
|
29
33
|
}
|
|
30
34
|
|
|
31
35
|
/**
|
|
32
36
|
* Consists of an object where the keys match the breakpoint names used in the query. The values are objects with keys representing prop names and values representing prop values Ex. `{small: { myProp: 'fillscreen' }, large: { myProp: 'fillcontainer' }}`
|
|
33
37
|
*/
|
|
34
|
-
|
|
38
|
+
type ResponsiveByBreakpointProps = {
|
|
35
39
|
[breakpointName: string]: ResponsivePropsObject
|
|
36
40
|
}
|
|
37
41
|
|
|
38
|
-
|
|
42
|
+
type ResponsiveOwnProps = {
|
|
39
43
|
/**
|
|
40
44
|
* Consists of an object where the keys define the names of breakpoints. The values are query objects
|
|
41
45
|
* with keys representing the breakpoint condition and values representing a breakpoint value as a
|
|
@@ -74,3 +78,32 @@ export type ResponsiveProps = {
|
|
|
74
78
|
matches?: QueriesMatching
|
|
75
79
|
) => any
|
|
76
80
|
}
|
|
81
|
+
|
|
82
|
+
type PropKeys = keyof ResponsiveOwnProps
|
|
83
|
+
|
|
84
|
+
type AllowedPropKeys = Readonly<Array<PropKeys>>
|
|
85
|
+
|
|
86
|
+
type ResponsiveProps = ResponsiveOwnProps
|
|
87
|
+
|
|
88
|
+
const propTypes: PropValidators<PropKeys> = {
|
|
89
|
+
match: PropTypes.oneOf(['element', 'media']),
|
|
90
|
+
query: PropTypes.objectOf(ResponsivePropTypes.validQuery).isRequired,
|
|
91
|
+
props: PropTypes.objectOf(PropTypes.object),
|
|
92
|
+
render: PropTypes.func,
|
|
93
|
+
children: PropTypes.func
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
const allowedProps: AllowedPropKeys = [
|
|
97
|
+
'match',
|
|
98
|
+
'query',
|
|
99
|
+
'props',
|
|
100
|
+
'render',
|
|
101
|
+
'children'
|
|
102
|
+
]
|
|
103
|
+
|
|
104
|
+
export type {
|
|
105
|
+
ResponsiveProps,
|
|
106
|
+
ResponsivePropsObject,
|
|
107
|
+
ResponsiveByBreakpointProps
|
|
108
|
+
}
|
|
109
|
+
export { propTypes, allowedProps }
|
package/src/index.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { Component } from 'react';
|
|
2
|
-
import PropTypes from 'prop-types';
|
|
3
2
|
import { BreakpointQueries, QueriesMatching, UpdateMatches } from '../QueryType';
|
|
4
|
-
import { ResponsiveByBreakpointProps, ResponsiveProps, ResponsivePropsObject } from './
|
|
3
|
+
import type { ResponsiveByBreakpointProps, ResponsiveProps, ResponsivePropsObject } from './props';
|
|
5
4
|
/**
|
|
6
5
|
---
|
|
7
6
|
category: components
|
|
@@ -9,20 +8,22 @@ category: components
|
|
|
9
8
|
@tsProps
|
|
10
9
|
**/
|
|
11
10
|
declare class Responsive extends Component<ResponsiveProps> {
|
|
12
|
-
static
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
props
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
11
|
+
static allowedProps: readonly (keyof {
|
|
12
|
+
query: BreakpointQueries;
|
|
13
|
+
match?: "element" | "media" | undefined;
|
|
14
|
+
props?: ResponsiveByBreakpointProps | undefined;
|
|
15
|
+
render?: ((props?: ResponsivePropsObject | null | undefined, matches?: QueriesMatching | undefined) => any) | undefined;
|
|
16
|
+
children?: ((props?: ResponsivePropsObject | null | undefined, matches?: QueriesMatching | undefined) => any) | undefined;
|
|
17
|
+
})[];
|
|
18
|
+
static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
|
|
19
|
+
query: BreakpointQueries;
|
|
20
|
+
match?: "element" | "media" | undefined;
|
|
21
|
+
props?: ResponsiveByBreakpointProps | undefined;
|
|
22
|
+
render?: ((props?: ResponsivePropsObject | null | undefined, matches?: QueriesMatching | undefined) => any) | undefined;
|
|
23
|
+
children?: ((props?: ResponsivePropsObject | null | undefined, matches?: QueriesMatching | undefined) => any) | undefined;
|
|
24
|
+
}>;
|
|
23
25
|
static defaultProps: {
|
|
24
26
|
children: null;
|
|
25
|
-
render: undefined;
|
|
26
27
|
match: string;
|
|
27
28
|
props: null;
|
|
28
29
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Responsive/index.tsx"],"names":[],"mappings":"AAwBA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Responsive/index.tsx"],"names":[],"mappings":"AAwBA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUxC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEhF,OAAO,KAAK,EACV,2BAA2B,EAC3B,eAAe,EACf,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAGhB;;;;;GAKG;AACH,cAAM,UAAW,SAAQ,SAAS,CAAC,eAAe,CAAC;IACjD,MAAM,CAAC,YAAY;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;MAIlB;IAED,cAAc,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAEhD,KAAK,EAAE;QAAE,OAAO,EAAE,eAAe,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAGxD;IAED,iBAAiB;IA0BjB,oBAAoB;IAIpB,kBAAkB,CAAC,SAAS,EAAE,eAAe;IAa7C,gBAAgB,CACd,KAAK,EAAE,iBAAiB,EACxB,aAAa,EAAE,aAAa,EAC5B,KAAK,kCAAmB;;;IAS1B,mBAAmB;IAMnB,aAAa,EAAE,aAAa,CAM3B;IAED,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,2BAA2B;IAgCxE,MAAM;CAkBP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}
|
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import type { PropValidators } from '@instructure/shared-types';
|
|
2
|
+
import type { BreakpointQueries, QueriesMatching } from '../QueryType';
|
|
3
|
+
interface ResponsivePropsObject {
|
|
3
4
|
[propName: string]: any;
|
|
4
5
|
}
|
|
5
6
|
/**
|
|
6
7
|
* Consists of an object where the keys match the breakpoint names used in the query. The values are objects with keys representing prop names and values representing prop values Ex. `{small: { myProp: 'fillscreen' }, large: { myProp: 'fillcontainer' }}`
|
|
7
8
|
*/
|
|
8
|
-
|
|
9
|
+
declare type ResponsiveByBreakpointProps = {
|
|
9
10
|
[breakpointName: string]: ResponsivePropsObject;
|
|
10
11
|
};
|
|
11
|
-
|
|
12
|
+
declare type ResponsiveOwnProps = {
|
|
12
13
|
/**
|
|
13
14
|
* Consists of an object where the keys define the names of breakpoints. The values are query objects
|
|
14
15
|
* with keys representing the breakpoint condition and values representing a breakpoint value as a
|
|
@@ -37,4 +38,11 @@ export declare type ResponsiveProps = {
|
|
|
37
38
|
*/
|
|
38
39
|
children?: (props?: ResponsivePropsObject | null, matches?: QueriesMatching) => any;
|
|
39
40
|
};
|
|
40
|
-
|
|
41
|
+
declare type PropKeys = keyof ResponsiveOwnProps;
|
|
42
|
+
declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
43
|
+
declare type ResponsiveProps = ResponsiveOwnProps;
|
|
44
|
+
declare const propTypes: PropValidators<PropKeys>;
|
|
45
|
+
declare const allowedProps: AllowedPropKeys;
|
|
46
|
+
export type { ResponsiveProps, ResponsivePropsObject, ResponsiveByBreakpointProps };
|
|
47
|
+
export { propTypes, allowedProps };
|
|
48
|
+
//# sourceMappingURL=props.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Responsive/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEtE,UAAU,qBAAqB;IAC7B,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACxB;AAED;;GAEG;AACH,aAAK,2BAA2B,GAAG;IACjC,CAAC,cAAc,EAAE,MAAM,GAAG,qBAAqB,CAAA;CAChD,CAAA;AAED,aAAK,kBAAkB,GAAG;IACxB;;;;OAIG;IACH,KAAK,EAAE,iBAAiB,CAAA;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAE3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAA;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CACP,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EACpC,OAAO,CAAC,EAAE,eAAe,KACtB,GAAG,CAAA;IAER;;;OAGG;IACH,QAAQ,CAAC,EAAE,CACT,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EACpC,OAAO,CAAC,EAAE,eAAe,KACtB,GAAG,CAAA;CACT,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAAG,kBAAkB,CAAA;AAEzC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAMvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAMnB,CAAA;AAED,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC5B,CAAA;AACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|
package/types/index.d.ts
CHANGED
|
@@ -4,6 +4,6 @@ export { addMediaQueryMatchListener } from './addMediaQueryMatchListener';
|
|
|
4
4
|
export { parseQuery } from './parseQuery';
|
|
5
5
|
export { jsonToMediaQuery } from './jsonToMediaQuery';
|
|
6
6
|
export { ResponsivePropTypes } from './ResponsivePropTypes';
|
|
7
|
-
export type { ResponsiveProps, ResponsivePropsObject, ResponsiveByBreakpointProps } from './Responsive/
|
|
7
|
+
export type { ResponsiveProps, ResponsivePropsObject, ResponsiveByBreakpointProps } from './Responsive/props';
|
|
8
8
|
export type { BreakpointQueries, Query, ValidQueryKey, QueriesMatching } from './QueryType';
|
|
9
9
|
//# sourceMappingURL=index.d.ts.map
|
package/LICENSE.md
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: The MIT License (MIT)
|
|
3
|
-
category: Getting Started
|
|
4
|
-
order: 9
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# The MIT License (MIT)
|
|
8
|
-
|
|
9
|
-
Copyright (c) 2015 Instructure, Inc.
|
|
10
|
-
|
|
11
|
-
**Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
12
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
13
|
-
in the Software without restriction, including without limitation the rights
|
|
14
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
15
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
16
|
-
furnished to do so, subject to the following conditions.**
|
|
17
|
-
|
|
18
|
-
The above copyright notice and this permission notice shall be included in all
|
|
19
|
-
copies or substantial portions of the Software.
|
|
20
|
-
|
|
21
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
22
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
23
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
24
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
25
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
26
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
27
|
-
SOFTWARE.
|
package/es/Responsive/types.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
package/lib/Responsive/types.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/Responsive/types.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEjE,MAAM,WAAW,qBAAqB;IACpC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACxB;AAED;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACxC,CAAC,cAAc,EAAE,MAAM,GAAG,qBAAqB,CAAA;CAChD,CAAA;AAED,oBAAY,eAAe,GAAG;IAC5B;;;;OAIG;IACH,KAAK,EAAE,iBAAiB,CAAA;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAE3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAA;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CACP,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EACpC,OAAO,CAAC,EAAE,eAAe,KACtB,GAAG,CAAA;IAER;;;OAGG;IACH,QAAQ,CAAC,EAAE,CACT,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EACpC,OAAO,CAAC,EAAE,eAAe,KACtB,GAAG,CAAA;CACT,CAAA"}
|