Skip to content

Commit 4d15ae8

Browse files
chore(release): 1.0.0-alpha.1
# [1.0.0-alpha.1](v0.2.3...v1.0.0-alpha.1) (2021-10-29) ### Features * update api and types to match latest dash alpha ([d04ec1d](d04ec1d)) ### BREAKING CHANGES * responsive() no longer returns a function, it returns an object. The function it used to return is now on the "variants" property.
1 parent d04ec1d commit 4d15ae8

File tree

3 files changed

+37
-23
lines changed

3 files changed

+37
-23
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
# [1.0.0-alpha.1](https://github.com/dash-ui/responsive/compare/v0.2.3...v1.0.0-alpha.1) (2021-10-29)
2+
3+
### Features
4+
5+
- update api and types to match latest dash alpha ([d04ec1d](https://github.com/dash-ui/responsive/commit/d04ec1d467d9f74e294798ed1e6fe1e48172abdb))
6+
7+
### BREAKING CHANGES
8+
9+
- responsive() no longer returns a function, it returns an object. The function it
10+
used to return is now on the "variants" property.
11+
112
# Changelog
213

314
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dash-ui/responsive",
3-
"version": "0.2.3",
3+
"version": "1.0.0-alpha.1",
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

+25-22
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,48 @@
11
import type {
2-
Styles,
3-
StyleMap,
4-
StyleValue,
5-
StyleCallback,
6-
StyleObject,
2+
DashThemes,
73
DashTokens,
84
Falsy,
95
LazyValue,
6+
StyleCallback,
7+
StyleMap,
8+
StyleObject,
9+
Styles,
10+
StyleValue,
1011
} from "@dash-ui/styles";
1112
declare function responsive<
1213
Tokens extends DashTokens,
13-
MQ extends Record<string, string>,
14-
ThemeNames extends string
14+
Themes extends DashThemes,
15+
MQ extends Record<string, string>
1516
>(
16-
styles: Styles<Tokens, ThemeNames>,
17+
styles: Styles<Tokens, Themes>,
1718
mediaQueries: MQ
18-
): ResponsiveStyles<Tokens, MQ, ThemeNames>;
19+
): ResponsiveStyles<Tokens, Themes, MQ>;
1920
export interface ResponsiveStyles<
2021
Tokens extends DashTokens,
21-
MQ extends Record<string, string>,
22-
ThemeNames extends string
23-
> extends Styles<Tokens, ThemeNames> {
24-
<Variant extends string>(
25-
styleMap: StyleMap<Variant, Tokens>
26-
): ResponsiveStyle<Variant, Tokens, MQ>;
22+
Themes extends DashThemes,
23+
MQ extends Record<string, string>
24+
> extends Styles<Tokens, Themes> {
25+
variants<Variant extends string>(
26+
styleMap: StyleMap<Variant, Tokens, Themes>
27+
): ResponsiveStyle<Variant, Tokens, Themes, MQ>;
2728
lazy<Variant extends LazyValue>(
28-
lazyFn: ResponsiveLazyCallback<Variant, Tokens, MQ>
29+
lazyFn: ResponsiveLazyCallback<Variant, Tokens, Themes, MQ>
2930
): ResponsiveLazy<Variant, MQ>;
3031
one(
3132
literals:
3233
| TemplateStringsArray
3334
| string
3435
| StyleObject
35-
| StyleCallback<Tokens>,
36+
| StyleCallback<Tokens, Themes>,
3637
...placeholders: string[]
3738
): ResponsiveOne<MQ>;
3839
cls(
3940
style:
4041
| TemplateStringsArray
4142
| string
4243
| StyleObject
43-
| StyleCallback<Tokens>
44-
| Responsive<string | StyleObject | StyleCallback<Tokens>, MQ>
44+
| StyleCallback<Tokens, Themes>
45+
| Responsive<string | StyleObject | StyleCallback<Tokens, Themes>, MQ>
4546
): string;
4647
}
4748
export declare type Responsive<Variant, MQ extends Record<string, string>> = {
@@ -67,11 +68,12 @@ export declare type ResponsiveStyleArguments<
6768
export interface ResponsiveStyle<
6869
Variant extends string,
6970
Tokens extends DashTokens,
71+
Themes extends DashThemes,
7072
MQ extends Record<string, string>
7173
> {
7274
(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
7375
css(...variants: ResponsiveStyleArguments<Variant, MQ>): string;
74-
styles: StyleMap<Variant, Tokens>;
76+
styles: StyleMap<Variant, Tokens, Themes>;
7577
}
7678
export declare type ResponsiveLazy<
7779
Value extends LazyValue,
@@ -82,19 +84,20 @@ export declare type ResponsiveLazy<
8284
* A method that returns indeterminate CSS strings based on the value
8385
* when called.
8486
*
85-
* @param value A JSON serializable value to create indeterminate
87+
* @param value - A JSON serializable value to create indeterminate
8688
* styles from
8789
*/
8890
css(value?: Value | Responsive<Value, MQ>): string;
8991
};
9092
export declare type ResponsiveLazyCallback<
9193
Variant extends LazyValue,
9294
Tokens extends DashTokens,
95+
Themes extends DashThemes,
9396
MQ extends Record<string, string>
9497
> = (
9598
value: Variant,
9699
queryName: "default" | Extract<keyof MQ, string>
97-
) => StyleValue<Tokens>;
100+
) => StyleValue<Tokens, Themes>;
98101
export declare type ResponsiveOne<MQ extends Record<string, string>> = {
99102
(
100103
createClassName?:

0 commit comments

Comments
 (0)