Skip to content

Commit 25ae1a1

Browse files
chore(release): 1.0.1
## [1.0.1](v1.0.0...v1.0.1) (2022-08-18) ### Bug Fixes * add explicit function return types ([#12](#12)) ([8dc23af](8dc23af))
1 parent 8dc23af commit 25ae1a1

File tree

4 files changed

+44
-10
lines changed

4 files changed

+44
-10
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## [1.0.1](https://github.com/dash-ui/mq/compare/v1.0.0...v1.0.1) (2022-08-18)
2+
3+
### Bug Fixes
4+
5+
- add explicit function return types ([#12](https://github.com/dash-ui/mq/issues/12)) ([8dc23af](https://github.com/dash-ui/mq/commit/8dc23af4fddfc0fabb2ffa453ad915942e2d453d))
6+
17
# [1.0.0](https://github.com/dash-ui/mq/compare/v0.4.1...v1.0.0) (2022-06-25)
28

39
### Bug Fixes

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dash-ui/mq",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "A utility function for adding reusable media queries and breakpoints to @dash-ui styles",
55
"license": "MIT",
66
"author": "Jared Lunde <[email protected]> (https://jaredlunde.com/)",

types/index.d.ts

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,47 @@
1-
import type { DashThemes, DashTokens, StyleCallback, StyleObject, Styles } from "@dash-ui/styles";
1+
import type {
2+
DashThemes,
3+
DashTokens,
4+
StyleCallback,
5+
StyleObject,
6+
Styles,
7+
} from "@dash-ui/styles";
28
/**
39
* A factory function that creates a utility for adding breakpoints and
410
* media queries to Dash styles
511
*
612
* @param styles - A Dash `styles` instance
713
* @param mediaQueries - A map of media query name/query pairs
814
*/
9-
declare function mq<Tokens extends DashTokens = DashTokens, Themes extends DashThemes = DashThemes, QueryNames extends string | number = string | number>(styles: Styles<Tokens, Themes>, mediaQueries: MediaQueries<QueryNames>): {
10-
(queryName: QueryNames): string;
11-
(queryName: MediaQueryObject<QueryNames, Tokens, Themes>): string;
12-
};
15+
declare function mq<
16+
Tokens extends DashTokens = DashTokens,
17+
Themes extends DashThemes = DashThemes,
18+
QueryNames extends string | number = string | number
19+
>(
20+
styles: Styles<Tokens, Themes>,
21+
mediaQueries: MediaQueries<QueryNames>
22+
): MqStyles<QueryNames, Tokens, Themes>;
1323
export default mq;
24+
export declare type MqStyles<
25+
QueryNames extends string | number,
26+
Tokens extends DashTokens = DashTokens,
27+
Themes extends DashThemes = DashThemes
28+
> = {
29+
(queryName: QueryNames): string;
30+
(queryName: MediaQueryObject<QueryNames, Tokens, Themes>): string;
31+
(
32+
queryName: QueryNames | MediaQueryObject<QueryNames, Tokens, Themes>
33+
): string;
34+
};
1435
export declare type MediaQueries<QueryNames extends string | number> = {
15-
readonly [K in QueryNames]: string;
36+
readonly [K in QueryNames]: string;
1637
};
17-
export declare type MediaQueryObject<QueryNames extends string | number, Tokens extends DashTokens = DashTokens, Themes extends DashThemes = DashThemes> = {
18-
readonly [K in QueryNames | "default"]?: string | StyleObject | StyleCallback<Tokens, Themes>;
38+
export declare type MediaQueryObject<
39+
QueryNames extends string | number,
40+
Tokens extends DashTokens = DashTokens,
41+
Themes extends DashThemes = DashThemes
42+
> = {
43+
readonly [K in QueryNames | "default"]?:
44+
| string
45+
| StyleObject
46+
| StyleCallback<Tokens, Themes>;
1947
};

0 commit comments

Comments
 (0)