Skip to content

Commit 7f825a2

Browse files
chore(release): 1.0.0-alpha.6
# [1.0.0-alpha.6](v1.0.0-alpha.5...v1.0.0-alpha.6) (2022-06-25) ### Bug Fixes * remove alpha version from peer deps ([16e6247](16e6247))
1 parent 16e6247 commit 7f825a2

File tree

3 files changed

+126
-36
lines changed

3 files changed

+126
-36
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# [1.0.0-alpha.6](https://github.com/dash-ui/responsive/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2022-06-25)
2+
3+
### Bug Fixes
4+
5+
- remove alpha version from peer deps ([16e6247](https://github.com/dash-ui/responsive/commit/16e6247256322d9edc7b4ce27e415d58f8f9d4ad))
6+
17
# [1.0.0-alpha.5](https://github.com/dash-ui/responsive/compare/v1.0.0-alpha.4...v1.0.0-alpha.5) (2021-10-31)
28

39
### Performance Improvements

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dash-ui/responsive",
3-
"version": "1.0.0-alpha.5",
3+
"version": "1.0.0-alpha.6",
44
"description": "A library for adding responsive style props to components with @dash-ui",
55
"license": "MIT",
66
"author": "Jared Lunde <[email protected]> (https://jaredlunde.com/)",

types/index.d.ts

+119-35
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,126 @@
1-
import type { DashThemes, DashTokens, Falsy, LazyValue, StyleCallback, StyleMap, StyleObject, Styles, StyleValue } from "@dash-ui/styles";
2-
declare function responsive<Tokens extends DashTokens, Themes extends DashThemes, MQ extends Record<string, string>>(styles: Styles<Tokens, Themes>, mediaQueries: MQ): ResponsiveStyles<Tokens, Themes, MQ>;
3-
export interface ResponsiveStyles<Tokens extends DashTokens, Themes extends DashThemes, MQ extends Record<string, string>> extends Styles<Tokens, Themes> {
4-
variants<Variant extends string | number>(styleMap: StyleMap<Variant, Tokens, Themes>): ResponsiveStyle<Variant, Tokens, Themes, MQ>;
5-
lazy<Variant extends LazyValue>(lazyFn: ResponsiveLazyCallback<Variant, Tokens, Themes, MQ>): ResponsiveLazy<Variant, MQ>;
6-
one(literals: TemplateStringsArray | string | StyleObject | StyleCallback<Tokens, Themes>, ...placeholders: string[]): ResponsiveOne<MQ>;
7-
cls(style: TemplateStringsArray | string | StyleObject | StyleCallback<Tokens, Themes> | Responsive<string | StyleObject | StyleCallback<Tokens, Themes>, MQ>): string;
1+
import type {
2+
DashThemes,
3+
DashTokens,
4+
Falsy,
5+
LazyValue,
6+
StyleCallback,
7+
StyleMap,
8+
StyleObject,
9+
Styles,
10+
StyleValue,
11+
} from "@dash-ui/styles";
12+
declare function responsive<
13+
Tokens extends DashTokens,
14+
Themes extends DashThemes,
15+
MQ extends Record<string, string>
16+
>(
17+
styles: Styles<Tokens, Themes>,
18+
mediaQueries: MQ
19+
): Readonly<ResponsiveStyles<Tokens, Themes, MQ>>;
20+
export interface ResponsiveStyles<
21+
Tokens extends DashTokens,
22+
Themes extends DashThemes,
23+
MQ extends Record<string, string>
24+
> extends Styles<Tokens, Themes> {
25+
variants<Variant extends string | number>(
26+
styleMap: StyleMap<Variant, Tokens, Themes>
27+
): ResponsiveStyle<Variant, Tokens, Themes, MQ>;
28+
lazy<Variant extends LazyValue>(
29+
lazyFn: ResponsiveLazyCallback<Variant, Tokens, Themes, MQ>
30+
): ResponsiveLazy<Variant, MQ>;
31+
one(
32+
literals:
33+
| TemplateStringsArray
34+
| string
35+
| StyleObject
36+
| StyleCallback<Tokens, Themes>,
37+
...placeholders: string[]
38+
): ResponsiveOne<MQ>;
39+
cls(
40+
style:
41+
| TemplateStringsArray
42+
| string
43+
| StyleObject
44+
| StyleCallback<Tokens, Themes>
45+
| Responsive<string | StyleObject | StyleCallback<Tokens, Themes>, MQ>
46+
): string;
847
}
9-
export declare type Responsive<Variant, MQ extends Record<string | number, string>> = {
10-
[key in Extract<keyof MQ, string | number>]?: Variant;
48+
export declare type Responsive<
49+
Variant,
50+
MQ extends Record<string | number, string>
51+
> = {
52+
[key in Extract<keyof MQ, string | number>]?: Variant;
1153
};
12-
export declare type ResponsiveStyleArguments<Variant extends string | number, MQ extends Record<string | number, string>> = (Variant | Falsy | {
13-
[Name in Variant]?: boolean | null | undefined | string | number;
14-
} | Responsive<Variant | Falsy, MQ> | Responsive<{
15-
[Name in Variant]?: boolean | null | undefined | string | number;
16-
}, MQ>)[];
17-
export interface ResponsiveStyle<Variant extends string | number, Tokens extends DashTokens, Themes extends DashThemes, MQ extends Record<string | number, string>> {
18-
(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
19-
css(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
20-
styles: StyleMap<Variant, Tokens, Themes>;
54+
export declare type ResponsiveStyleArguments<
55+
Variant extends string | number,
56+
MQ extends Record<string | number, string>
57+
> = (
58+
| Variant
59+
| Falsy
60+
| {
61+
[Name in Variant]?: boolean | null | undefined | string | number;
62+
}
63+
| Responsive<Variant | Falsy, MQ>
64+
| Responsive<
65+
{
66+
[Name in Variant]?: boolean | null | undefined | string | number;
67+
},
68+
MQ
69+
>
70+
)[];
71+
export interface ResponsiveStyle<
72+
Variant extends string | number,
73+
Tokens extends DashTokens,
74+
Themes extends DashThemes,
75+
MQ extends Record<string | number, string>
76+
> {
77+
(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
78+
css(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
79+
styles: StyleMap<Variant, Tokens, Themes>;
2180
}
22-
export declare type ResponsiveLazy<Value extends LazyValue, MQ extends Record<string | number, string>> = {
23-
(value?: Value | Responsive<Value, MQ>): string;
24-
/**
25-
* A method that returns indeterminate CSS strings based on the value
26-
* when called.
27-
*
28-
* @param value - A JSON serializable value to create indeterminate
29-
* styles from
30-
*/
31-
css(value?: Value | Responsive<Value, MQ>): string;
81+
export declare type ResponsiveLazy<
82+
Value extends LazyValue,
83+
MQ extends Record<string | number, string>
84+
> = {
85+
(value?: Value | Responsive<Value, MQ>): string;
86+
/**
87+
* A method that returns indeterminate CSS strings based on the value
88+
* when called.
89+
*
90+
* @param value - A JSON serializable value to create indeterminate
91+
* styles from
92+
*/
93+
css(value?: Value | Responsive<Value, MQ>): string;
3294
};
33-
export declare type ResponsiveLazyCallback<Variant extends LazyValue, Tokens extends DashTokens, Themes extends DashThemes, MQ extends Record<string | number, string>> = (value: Variant, queryName: "default" | Extract<keyof MQ, string | number>) => StyleValue<Tokens, Themes>;
95+
export declare type ResponsiveLazyCallback<
96+
Variant extends LazyValue,
97+
Tokens extends DashTokens,
98+
Themes extends DashThemes,
99+
MQ extends Record<string | number, string>
100+
> = (
101+
value: Variant,
102+
queryName: "default" | Extract<keyof MQ, string | number>
103+
) => StyleValue<Tokens, Themes>;
34104
export declare type ResponsiveOne<MQ extends Record<string, string>> = {
35-
(createClassName?: boolean | number | string | null | Responsive<boolean | number | string | null, MQ>): string;
36-
/**
37-
* A method that returns a CSS string when the first argument
38-
* is not falsy
39-
*/
40-
css(createCss?: boolean | number | string | null | Responsive<boolean | number | string | null, MQ>): string;
105+
(
106+
createClassName?:
107+
| boolean
108+
| number
109+
| string
110+
| null
111+
| Responsive<boolean | number | string | null, MQ>
112+
): string;
113+
/**
114+
* A method that returns a CSS string when the first argument
115+
* is not falsy
116+
*/
117+
css(
118+
createCss?:
119+
| boolean
120+
| number
121+
| string
122+
| null
123+
| Responsive<boolean | number | string | null, MQ>
124+
): string;
41125
};
42126
export default responsive;

0 commit comments

Comments
 (0)