@atlaskit/editor-palette 1.4.2 → 1.5.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/{.babelrc → .babelrc.cts} +2 -2
- package/CHANGELOG.md +12 -0
- package/dist/cjs/background.js +89 -37
- package/dist/cjs/index.js +4 -4
- package/dist/cjs/table-charts.js +128 -47
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/background.js +45 -33
- package/dist/es2019/index.js +2 -2
- package/dist/es2019/table-charts.js +54 -41
- package/dist/es2019/version.json +1 -1
- package/dist/esm/background.js +87 -34
- package/dist/esm/index.js +2 -2
- package/dist/esm/table-charts.js +126 -43
- package/dist/esm/version.json +1 -1
- package/dist/types/background.d.ts +41 -25
- package/dist/types/index.d.ts +2 -2
- package/dist/types/table-charts.d.ts +50 -39
- package/dist/types-ts4.5/background.d.ts +41 -25
- package/dist/types-ts4.5/index.d.ts +2 -2
- package/dist/types-ts4.5/table-charts.d.ts +50 -39
- package/package.json +4 -6
- package/report.api.md +64 -143
- package/tmp/api-report-tmp.d.ts +319 -0
|
@@ -18,7 +18,20 @@
|
|
|
18
18
|
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color
|
|
19
19
|
*/
|
|
20
20
|
export declare function hexToEditorTableChartsPaletteColor<HexColor extends string>(hexColor: HexColor): HexColor extends EditorTableChartsPaletteKey ? EditorTableChartsPalette[HexColor]['token'] : string | undefined;
|
|
21
|
-
|
|
21
|
+
/**
|
|
22
|
+
* Takes an ADF hex color and returns the rendered hex code for the associated chart palette design token using getTokenValue.
|
|
23
|
+
* If the provided color does not exist in the Editor color palette, this function returns undefined.
|
|
24
|
+
*
|
|
25
|
+
* This should only be used when rendering content where CSS variables are not feasible, such as a non-CSS environment
|
|
26
|
+
* or to enable cross-app copy/paste.
|
|
27
|
+
*
|
|
28
|
+
* WARNING: If the rendered theme changes (such as from light -> dark mode) the value returned here will no longer match
|
|
29
|
+
* the surrounding UI and will need to be re-fetched.
|
|
30
|
+
* In addition, the values of tokens will differ between themes and the value for a given theme can and will change.
|
|
31
|
+
* - **DO NOT**: store the output of these functions in any user-generated content or back-end.
|
|
32
|
+
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color.
|
|
33
|
+
*/
|
|
34
|
+
export declare function hexToEditorTableChartsPaletteRawValue<HexColor extends string>(hexColor: HexColor): HexColor extends EditorTableChartsPaletteKey ? string : undefined;
|
|
22
35
|
type EditorTableChartsPalette = typeof editorTableChartsPalette;
|
|
23
36
|
export type EditorTableChartsPaletteKey = keyof EditorTableChartsPalette;
|
|
24
37
|
/**
|
|
@@ -33,150 +46,148 @@ export type EditorTableChartsPaletteKey = keyof EditorTableChartsPalette;
|
|
|
33
46
|
*/
|
|
34
47
|
declare const editorTableChartsPalette: {
|
|
35
48
|
"#7AB2FF": {
|
|
36
|
-
|
|
49
|
+
getValue: (fallback: string) => string;
|
|
37
50
|
token: "var(--ds-background-accent-blue-subtle, #7AB2FF)";
|
|
38
51
|
};
|
|
39
52
|
"#60C6D2": {
|
|
40
|
-
|
|
53
|
+
getValue: (fallback: string) => string;
|
|
41
54
|
token: "var(--ds-background-accent-teal-subtle, #60C6D2)";
|
|
42
55
|
};
|
|
43
56
|
"#6BE1B0": {
|
|
44
|
-
|
|
57
|
+
getValue: (fallback: string) => string;
|
|
45
58
|
token: "var(--ds-background-accent-green-subtle, #6BE1B0)";
|
|
46
59
|
};
|
|
47
60
|
"#FFDB57": {
|
|
48
|
-
|
|
61
|
+
getValue: (fallback: string) => string;
|
|
49
62
|
token: "var(--ds-background-accent-yellow-subtle, #FFDB57)";
|
|
50
63
|
};
|
|
51
64
|
"#FAA53D": {
|
|
52
|
-
|
|
65
|
+
getValue: (fallback: string) => string;
|
|
53
66
|
token: "var(--ds-background-accent-orange-subtle, #FAA53D)";
|
|
54
67
|
};
|
|
55
68
|
"#FF8F73": {
|
|
56
|
-
|
|
69
|
+
getValue: (fallback: string) => string;
|
|
57
70
|
token: "var(--ds-background-accent-red-subtle, #FF8F73)";
|
|
58
71
|
};
|
|
59
72
|
"#E774BB": {
|
|
60
|
-
|
|
73
|
+
getValue: (fallback: string) => string;
|
|
61
74
|
token: "var(--ds-background-accent-magenta-subtle, #E774BB)";
|
|
62
75
|
};
|
|
63
76
|
"#B5A7FB": {
|
|
64
|
-
|
|
77
|
+
getValue: (fallback: string) => string;
|
|
65
78
|
token: "var(--ds-background-accent-purple-subtle, #B5A7FB)";
|
|
66
79
|
};
|
|
67
80
|
"#8993A5": {
|
|
68
|
-
|
|
81
|
+
getValue: (fallback: string) => string;
|
|
69
82
|
token: "var(--ds-background-accent-gray-subtler, #8993A5)";
|
|
70
83
|
};
|
|
71
84
|
"#247FFF": {
|
|
72
|
-
|
|
85
|
+
getValue: (fallback: string) => string;
|
|
73
86
|
token: "var(--ds-chart-blue-bold, #247FFF)";
|
|
74
87
|
};
|
|
75
88
|
"#1D9AAA": {
|
|
76
|
-
|
|
89
|
+
getValue: (fallback: string) => string;
|
|
77
90
|
token: "var(--ds-chart-teal-bold, #1D9AAA)";
|
|
78
91
|
};
|
|
79
92
|
"#23A971": {
|
|
80
|
-
|
|
93
|
+
getValue: (fallback: string) => string;
|
|
81
94
|
token: "var(--ds-chart-green-bold, #23A971)";
|
|
82
95
|
};
|
|
83
96
|
"#FFBE33": {
|
|
84
|
-
|
|
97
|
+
getValue: (fallback: string) => string;
|
|
85
98
|
token: "var(--ds-chart-yellow-bold, #FFBE33)";
|
|
86
99
|
};
|
|
87
100
|
"#D97008": {
|
|
88
|
-
|
|
101
|
+
getValue: (fallback: string) => string;
|
|
89
102
|
token: "var(--ds-chart-orange-bold, #D97008)";
|
|
90
103
|
};
|
|
91
104
|
"#FC552C": {
|
|
92
|
-
|
|
105
|
+
getValue: (fallback: string) => string;
|
|
93
106
|
token: "var(--ds-chart-red-bold, #FC552C)";
|
|
94
107
|
};
|
|
95
108
|
"#DA62AC": {
|
|
96
|
-
|
|
109
|
+
getValue: (fallback: string) => string;
|
|
97
110
|
token: "var(--ds-chart-magenta-bold, #DA62AC)";
|
|
98
111
|
};
|
|
99
112
|
"#8B77EE": {
|
|
100
|
-
|
|
113
|
+
getValue: (fallback: string) => string;
|
|
101
114
|
token: "var(--ds-chart-purple-bold, #8B77EE)";
|
|
102
115
|
};
|
|
103
116
|
"#8590A2": {
|
|
104
|
-
|
|
117
|
+
getValue: (fallback: string) => string;
|
|
105
118
|
token: "var(--ds-chart-gray-bold, #8590A2)";
|
|
106
119
|
};
|
|
107
120
|
"#0055CC": {
|
|
108
|
-
|
|
121
|
+
getValue: (fallback: string) => string;
|
|
109
122
|
token: "var(--ds-chart-blue-bolder, #0055CC)";
|
|
110
123
|
};
|
|
111
124
|
"#1D7F8C": {
|
|
112
|
-
|
|
125
|
+
getValue: (fallback: string) => string;
|
|
113
126
|
token: "var(--ds-chart-teal-bolder, #1D7F8C)";
|
|
114
127
|
};
|
|
115
128
|
"#177D52": {
|
|
116
|
-
|
|
129
|
+
getValue: (fallback: string) => string;
|
|
117
130
|
token: "var(--ds-chart-green-bolder, #177D52)";
|
|
118
131
|
};
|
|
119
132
|
"#FF9D00": {
|
|
120
|
-
|
|
133
|
+
getValue: (fallback: string) => string;
|
|
121
134
|
token: "var(--ds-chart-yellow-bolder, #FF9D00)";
|
|
122
135
|
};
|
|
123
136
|
"#B65C02": {
|
|
124
|
-
|
|
137
|
+
getValue: (fallback: string) => string;
|
|
125
138
|
token: "var(--ds-chart-orange-bolder, #B65C02)";
|
|
126
139
|
};
|
|
127
140
|
"#D32D03": {
|
|
128
|
-
|
|
141
|
+
getValue: (fallback: string) => string;
|
|
129
142
|
token: "var(--ds-chart-red-bolder, #D32D03)";
|
|
130
143
|
};
|
|
131
144
|
"#CD519D": {
|
|
132
|
-
|
|
145
|
+
getValue: (fallback: string) => string;
|
|
133
146
|
token: "var(--ds-chart-magenta-bolder, #CD519D)";
|
|
134
147
|
};
|
|
135
148
|
"#5A43D0": {
|
|
136
|
-
|
|
149
|
+
getValue: (fallback: string) => string;
|
|
137
150
|
token: "var(--ds-chart-purple-bolder, #5A43D0)";
|
|
138
151
|
};
|
|
139
152
|
"#758195": {
|
|
140
|
-
|
|
153
|
+
getValue: (fallback: string) => string;
|
|
141
154
|
token: "var(--ds-chart-gray-bolder, #758195)";
|
|
142
155
|
};
|
|
143
156
|
"#003884": {
|
|
144
|
-
|
|
157
|
+
getValue: (fallback: string) => string;
|
|
145
158
|
token: "var(--ds-chart-blue-boldest, #003884)";
|
|
146
159
|
};
|
|
147
160
|
"#206B74": {
|
|
148
|
-
|
|
161
|
+
getValue: (fallback: string) => string;
|
|
149
162
|
token: "var(--ds-chart-teal-boldest, #206B74)";
|
|
150
163
|
};
|
|
151
164
|
"#055C3F": {
|
|
152
|
-
|
|
165
|
+
getValue: (fallback: string) => string;
|
|
153
166
|
token: "var(--ds-chart-green-boldest, #055C3F)";
|
|
154
167
|
};
|
|
155
168
|
"#946104": {
|
|
156
|
-
|
|
169
|
+
getValue: (fallback: string) => string;
|
|
157
170
|
token: "var(--ds-chart-yellow-boldest, #946104)";
|
|
158
171
|
};
|
|
159
172
|
"#974F0C": {
|
|
160
|
-
|
|
173
|
+
getValue: (fallback: string) => string;
|
|
161
174
|
token: "var(--ds-chart-orange-boldest, #974F0C)";
|
|
162
175
|
};
|
|
163
176
|
"#A32000": {
|
|
164
|
-
|
|
177
|
+
getValue: (fallback: string) => string;
|
|
165
178
|
token: "var(--ds-chart-red-boldest, #A32000)";
|
|
166
179
|
};
|
|
167
180
|
"#943D73": {
|
|
168
|
-
|
|
181
|
+
getValue: (fallback: string) => string;
|
|
169
182
|
token: "var(--ds-chart-magenta-boldest, #943D73)";
|
|
170
183
|
};
|
|
171
184
|
"#44368B": {
|
|
172
|
-
|
|
185
|
+
getValue: (fallback: string) => string;
|
|
173
186
|
token: "var(--ds-chart-purple-boldest, #44368B)";
|
|
174
187
|
};
|
|
175
188
|
"#44546F": {
|
|
176
|
-
|
|
189
|
+
getValue: (fallback: string) => string;
|
|
177
190
|
token: "var(--ds-chart-gray-boldest, #44546F)";
|
|
178
191
|
};
|
|
179
192
|
};
|
|
180
|
-
declare const tokenNames: ("color.background.accent.blue.subtle" | "color.background.accent.teal.subtle" | "color.background.accent.green.subtle" | "color.background.accent.orange.subtle" | "color.background.accent.red.subtle" | "color.background.accent.purple.subtle" | "color.background.accent.yellow.subtle" | "color.background.accent.magenta.subtle" | "color.background.accent.gray.subtler" | "color.chart.blue.bold" | "color.chart.teal.bold" | "color.chart.green.bold" | "color.chart.yellow.bold" | "color.chart.orange.bold" | "color.chart.red.bold" | "color.chart.magenta.bold" | "color.chart.purple.bold" | "color.chart.gray.bold" | "color.chart.blue.bolder" | "color.chart.teal.bolder" | "color.chart.green.bolder" | "color.chart.yellow.bolder" | "color.chart.orange.bolder" | "color.chart.red.bolder" | "color.chart.magenta.bolder" | "color.chart.purple.bolder" | "color.chart.gray.bolder" | "color.chart.blue.boldest" | "color.chart.teal.boldest" | "color.chart.green.boldest" | "color.chart.yellow.boldest" | "color.chart.orange.boldest" | "color.chart.red.boldest" | "color.chart.magenta.boldest" | "color.chart.purple.boldest" | "color.chart.gray.boldest")[];
|
|
181
|
-
export type EditorBackgroundPaletteTokenNames = (typeof tokenNames)[number];
|
|
182
193
|
export {};
|
|
@@ -15,119 +15,135 @@
|
|
|
15
15
|
* The exact output of this function is an implementation detail and should only be used when rendering
|
|
16
16
|
* content to the user, on a client with a matching major version of `@atlaskit/tokens`.
|
|
17
17
|
* - **DO NOT**: store the output of these functions in any user-generated content or back-end.
|
|
18
|
-
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color
|
|
18
|
+
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color.
|
|
19
19
|
*/
|
|
20
20
|
export declare function hexToEditorBackgroundPaletteColor<HexColor extends string>(hexColor: HexColor): HexColor extends EditorBackgroundPaletteKey ? EditorBackgroundPalette[HexColor]['token'] : string | undefined;
|
|
21
|
-
|
|
21
|
+
/**
|
|
22
|
+
* Takes an ADF hex color and returns the rendered hex code for the associated background palette design token using getTokenValue.
|
|
23
|
+
* If the provided color does not exist in the Editor color palette, this function returns undefined.
|
|
24
|
+
*
|
|
25
|
+
* This should only be used when rendering content where CSS variables are not feasible, such as a non-CSS environment
|
|
26
|
+
* or to enable cross-app copy/paste.
|
|
27
|
+
*
|
|
28
|
+
* WARNING: If the rendered theme changes (such as from light -> dark mode) the value returned here will no longer match
|
|
29
|
+
* the surrounding UI and will need to be re-fetched.
|
|
30
|
+
* In addition, the values of tokens will differ between themes and the value for a given theme can and will change.
|
|
31
|
+
* - **DO NOT**: store the output of these functions in any user-generated content or back-end.
|
|
32
|
+
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color.
|
|
33
|
+
*/
|
|
34
|
+
export declare function hexToEditorBackgroundPaletteRawValue<HexColor extends string>(hexColor: HexColor): HexColor extends EditorBackgroundPaletteKey ? string : undefined;
|
|
22
35
|
type EditorBackgroundPalette = typeof editorBackgroundPalette;
|
|
23
36
|
export type EditorBackgroundPaletteKey = keyof EditorBackgroundPalette;
|
|
37
|
+
/**
|
|
38
|
+
* Values are asserted to improve generated type declarations
|
|
39
|
+
* Using object structure as getValue() function needed for table values, and other
|
|
40
|
+
* properties may be needed in the future.
|
|
41
|
+
*/
|
|
24
42
|
export declare const editorBackgroundPalette: {
|
|
25
43
|
/** blue - light */
|
|
26
44
|
"#DEEBFF": {
|
|
27
|
-
|
|
45
|
+
getValue: (fallback: string) => string;
|
|
28
46
|
token: "var(--ds-background-accent-blue-subtlest, #DEEBFF)";
|
|
29
47
|
};
|
|
30
48
|
/** blue - medium */
|
|
31
49
|
"#B3D4FF": {
|
|
32
|
-
|
|
50
|
+
getValue: (fallback: string) => string;
|
|
33
51
|
token: "var(--ds-background-accent-blue-subtler, #B3D4FF)";
|
|
34
52
|
};
|
|
35
53
|
/** blue - strong */
|
|
36
54
|
"#4C9AFF": {
|
|
37
|
-
|
|
55
|
+
getValue: (fallback: string) => string;
|
|
38
56
|
token: "var(--ds-background-accent-blue-subtle, #4C9AFF)";
|
|
39
57
|
};
|
|
40
58
|
/** teal - light */
|
|
41
59
|
"#E6FCFF": {
|
|
42
|
-
|
|
60
|
+
getValue: (fallback: string) => string;
|
|
43
61
|
token: "var(--ds-background-accent-teal-subtlest, #E6FCFF)";
|
|
44
62
|
};
|
|
45
63
|
/** teal - medium */
|
|
46
64
|
"#B3F5FF": {
|
|
47
|
-
|
|
65
|
+
getValue: (fallback: string) => string;
|
|
48
66
|
token: "var(--ds-background-accent-teal-subtler, #B3F5FF)";
|
|
49
67
|
};
|
|
50
68
|
/** teal - strong */
|
|
51
69
|
"#79E2F2": {
|
|
52
|
-
|
|
70
|
+
getValue: (fallback: string) => string;
|
|
53
71
|
token: "var(--ds-background-accent-teal-subtle, #79E2F2)";
|
|
54
72
|
};
|
|
55
73
|
/** green - light */
|
|
56
74
|
"#E3FCEF": {
|
|
57
|
-
|
|
75
|
+
getValue: (fallback: string) => string;
|
|
58
76
|
token: "var(--ds-background-accent-green-subtlest, #E3FCEF)";
|
|
59
77
|
};
|
|
60
78
|
/** green - medium */
|
|
61
79
|
"#ABF5D1": {
|
|
62
|
-
|
|
80
|
+
getValue: (fallback: string) => string;
|
|
63
81
|
token: "var(--ds-background-accent-green-subtler, #ABF5D1)";
|
|
64
82
|
};
|
|
65
83
|
/** green - strong */
|
|
66
84
|
"#57D9A3": {
|
|
67
|
-
|
|
85
|
+
getValue: (fallback: string) => string;
|
|
68
86
|
token: "var(--ds-background-accent-green-subtle, #57D9A3)";
|
|
69
87
|
};
|
|
70
88
|
/** yellowOrange - light */
|
|
71
89
|
"#FFFAE6": {
|
|
72
|
-
|
|
90
|
+
getValue: (fallback: string) => string;
|
|
73
91
|
token: "var(--ds-background-accent-yellow-subtlest, #FFFAE6)";
|
|
74
92
|
};
|
|
75
93
|
/** yellowOrange - medium */
|
|
76
94
|
"#FFF0B3": {
|
|
77
|
-
|
|
95
|
+
getValue: (fallback: string) => string;
|
|
78
96
|
token: "var(--ds-background-accent-yellow-subtler, #FFF0B3)";
|
|
79
97
|
};
|
|
80
98
|
/** yellowOrange - strong */
|
|
81
99
|
"#FFC400": {
|
|
82
|
-
|
|
100
|
+
getValue: (fallback: string) => string;
|
|
83
101
|
token: "var(--ds-background-accent-orange-subtle, #FFC400)";
|
|
84
102
|
};
|
|
85
103
|
/** red - light */
|
|
86
104
|
"#FFEBE6": {
|
|
87
|
-
|
|
105
|
+
getValue: (fallback: string) => string;
|
|
88
106
|
token: "var(--ds-background-accent-red-subtlest, #FFEBE6)";
|
|
89
107
|
};
|
|
90
108
|
/** red - medium */
|
|
91
109
|
"#FFBDAD": {
|
|
92
|
-
|
|
110
|
+
getValue: (fallback: string) => string;
|
|
93
111
|
token: "var(--ds-background-accent-red-subtler, #FFBDAD)";
|
|
94
112
|
};
|
|
95
113
|
/** red - strong */
|
|
96
114
|
"#FF8F73": {
|
|
97
|
-
|
|
115
|
+
getValue: (fallback: string) => string;
|
|
98
116
|
token: "var(--ds-background-accent-red-subtle, #FF8F73)";
|
|
99
117
|
};
|
|
100
118
|
/** purple - light */
|
|
101
119
|
"#EAE6FF": {
|
|
102
|
-
|
|
120
|
+
getValue: (fallback: string) => string;
|
|
103
121
|
token: "var(--ds-background-accent-purple-subtlest, #EAE6FF)";
|
|
104
122
|
};
|
|
105
123
|
/** purple - medium */
|
|
106
124
|
"#C0B6F2": {
|
|
107
|
-
|
|
125
|
+
getValue: (fallback: string) => string;
|
|
108
126
|
token: "var(--ds-background-accent-purple-subtler, #C0B6F2)";
|
|
109
127
|
};
|
|
110
128
|
/** purple - strong */
|
|
111
129
|
"#998DD9": {
|
|
112
|
-
|
|
130
|
+
getValue: (fallback: string) => string;
|
|
113
131
|
token: "var(--ds-background-accent-purple-subtle, #998DD9)";
|
|
114
132
|
};
|
|
115
133
|
/** whiteGray - light */
|
|
116
134
|
"#FFFFFF": {
|
|
117
|
-
|
|
135
|
+
getValue: (fallback: string) => string;
|
|
118
136
|
token: "var(--ds-surface, #FFFFFF)";
|
|
119
137
|
};
|
|
120
138
|
/** whiteGray - medium */
|
|
121
139
|
"#F4F5F7": {
|
|
122
|
-
|
|
140
|
+
getValue: (fallback: string) => string;
|
|
123
141
|
token: "var(--ds-background-accent-gray-subtlest, #F4F5F7)";
|
|
124
142
|
};
|
|
125
143
|
/** whiteGray - strong */
|
|
126
144
|
"#B3BAC5": {
|
|
127
|
-
|
|
145
|
+
getValue: (fallback: string) => string;
|
|
128
146
|
token: "var(--ds-background-accent-gray-subtle, #B3BAC5)";
|
|
129
147
|
};
|
|
130
148
|
};
|
|
131
|
-
declare const tokenNames: ("color.background.accent.blue.subtlest" | "color.background.accent.blue.subtler" | "color.background.accent.blue.subtle" | "color.background.accent.teal.subtlest" | "color.background.accent.teal.subtler" | "color.background.accent.teal.subtle" | "color.background.accent.green.subtlest" | "color.background.accent.green.subtler" | "color.background.accent.green.subtle" | "color.background.accent.yellow.subtlest" | "color.background.accent.yellow.subtler" | "color.background.accent.orange.subtle" | "color.background.accent.red.subtlest" | "color.background.accent.red.subtler" | "color.background.accent.red.subtle" | "color.background.accent.purple.subtlest" | "color.background.accent.purple.subtler" | "color.background.accent.purple.subtle" | "elevation.surface" | "color.background.accent.gray.subtlest" | "color.background.accent.gray.subtle")[];
|
|
132
|
-
export type EditorBackgroundPaletteTokenNames = (typeof tokenNames)[number];
|
|
133
149
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { hexToEditorBackgroundPaletteColor,
|
|
1
|
+
export { hexToEditorBackgroundPaletteColor, hexToEditorBackgroundPaletteRawValue, } from './background';
|
|
2
2
|
export { hexToEditorBorderPaletteColor } from './border';
|
|
3
3
|
export { hexToEditorTextPaletteColor } from './text';
|
|
4
|
-
export { hexToEditorTableChartsPaletteColor,
|
|
4
|
+
export { hexToEditorTableChartsPaletteColor, hexToEditorTableChartsPaletteRawValue, } from './table-charts';
|
|
@@ -18,7 +18,20 @@
|
|
|
18
18
|
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color
|
|
19
19
|
*/
|
|
20
20
|
export declare function hexToEditorTableChartsPaletteColor<HexColor extends string>(hexColor: HexColor): HexColor extends EditorTableChartsPaletteKey ? EditorTableChartsPalette[HexColor]['token'] : string | undefined;
|
|
21
|
-
|
|
21
|
+
/**
|
|
22
|
+
* Takes an ADF hex color and returns the rendered hex code for the associated chart palette design token using getTokenValue.
|
|
23
|
+
* If the provided color does not exist in the Editor color palette, this function returns undefined.
|
|
24
|
+
*
|
|
25
|
+
* This should only be used when rendering content where CSS variables are not feasible, such as a non-CSS environment
|
|
26
|
+
* or to enable cross-app copy/paste.
|
|
27
|
+
*
|
|
28
|
+
* WARNING: If the rendered theme changes (such as from light -> dark mode) the value returned here will no longer match
|
|
29
|
+
* the surrounding UI and will need to be re-fetched.
|
|
30
|
+
* In addition, the values of tokens will differ between themes and the value for a given theme can and will change.
|
|
31
|
+
* - **DO NOT**: store the output of these functions in any user-generated content or back-end.
|
|
32
|
+
* - **DO**: store the ADF hex color, and use these utilities at render time to display the themed version of the color.
|
|
33
|
+
*/
|
|
34
|
+
export declare function hexToEditorTableChartsPaletteRawValue<HexColor extends string>(hexColor: HexColor): HexColor extends EditorTableChartsPaletteKey ? string : undefined;
|
|
22
35
|
type EditorTableChartsPalette = typeof editorTableChartsPalette;
|
|
23
36
|
export type EditorTableChartsPaletteKey = keyof EditorTableChartsPalette;
|
|
24
37
|
/**
|
|
@@ -33,150 +46,148 @@ export type EditorTableChartsPaletteKey = keyof EditorTableChartsPalette;
|
|
|
33
46
|
*/
|
|
34
47
|
declare const editorTableChartsPalette: {
|
|
35
48
|
"#7AB2FF": {
|
|
36
|
-
|
|
49
|
+
getValue: (fallback: string) => string;
|
|
37
50
|
token: "var(--ds-background-accent-blue-subtle, #7AB2FF)";
|
|
38
51
|
};
|
|
39
52
|
"#60C6D2": {
|
|
40
|
-
|
|
53
|
+
getValue: (fallback: string) => string;
|
|
41
54
|
token: "var(--ds-background-accent-teal-subtle, #60C6D2)";
|
|
42
55
|
};
|
|
43
56
|
"#6BE1B0": {
|
|
44
|
-
|
|
57
|
+
getValue: (fallback: string) => string;
|
|
45
58
|
token: "var(--ds-background-accent-green-subtle, #6BE1B0)";
|
|
46
59
|
};
|
|
47
60
|
"#FFDB57": {
|
|
48
|
-
|
|
61
|
+
getValue: (fallback: string) => string;
|
|
49
62
|
token: "var(--ds-background-accent-yellow-subtle, #FFDB57)";
|
|
50
63
|
};
|
|
51
64
|
"#FAA53D": {
|
|
52
|
-
|
|
65
|
+
getValue: (fallback: string) => string;
|
|
53
66
|
token: "var(--ds-background-accent-orange-subtle, #FAA53D)";
|
|
54
67
|
};
|
|
55
68
|
"#FF8F73": {
|
|
56
|
-
|
|
69
|
+
getValue: (fallback: string) => string;
|
|
57
70
|
token: "var(--ds-background-accent-red-subtle, #FF8F73)";
|
|
58
71
|
};
|
|
59
72
|
"#E774BB": {
|
|
60
|
-
|
|
73
|
+
getValue: (fallback: string) => string;
|
|
61
74
|
token: "var(--ds-background-accent-magenta-subtle, #E774BB)";
|
|
62
75
|
};
|
|
63
76
|
"#B5A7FB": {
|
|
64
|
-
|
|
77
|
+
getValue: (fallback: string) => string;
|
|
65
78
|
token: "var(--ds-background-accent-purple-subtle, #B5A7FB)";
|
|
66
79
|
};
|
|
67
80
|
"#8993A5": {
|
|
68
|
-
|
|
81
|
+
getValue: (fallback: string) => string;
|
|
69
82
|
token: "var(--ds-background-accent-gray-subtler, #8993A5)";
|
|
70
83
|
};
|
|
71
84
|
"#247FFF": {
|
|
72
|
-
|
|
85
|
+
getValue: (fallback: string) => string;
|
|
73
86
|
token: "var(--ds-chart-blue-bold, #247FFF)";
|
|
74
87
|
};
|
|
75
88
|
"#1D9AAA": {
|
|
76
|
-
|
|
89
|
+
getValue: (fallback: string) => string;
|
|
77
90
|
token: "var(--ds-chart-teal-bold, #1D9AAA)";
|
|
78
91
|
};
|
|
79
92
|
"#23A971": {
|
|
80
|
-
|
|
93
|
+
getValue: (fallback: string) => string;
|
|
81
94
|
token: "var(--ds-chart-green-bold, #23A971)";
|
|
82
95
|
};
|
|
83
96
|
"#FFBE33": {
|
|
84
|
-
|
|
97
|
+
getValue: (fallback: string) => string;
|
|
85
98
|
token: "var(--ds-chart-yellow-bold, #FFBE33)";
|
|
86
99
|
};
|
|
87
100
|
"#D97008": {
|
|
88
|
-
|
|
101
|
+
getValue: (fallback: string) => string;
|
|
89
102
|
token: "var(--ds-chart-orange-bold, #D97008)";
|
|
90
103
|
};
|
|
91
104
|
"#FC552C": {
|
|
92
|
-
|
|
105
|
+
getValue: (fallback: string) => string;
|
|
93
106
|
token: "var(--ds-chart-red-bold, #FC552C)";
|
|
94
107
|
};
|
|
95
108
|
"#DA62AC": {
|
|
96
|
-
|
|
109
|
+
getValue: (fallback: string) => string;
|
|
97
110
|
token: "var(--ds-chart-magenta-bold, #DA62AC)";
|
|
98
111
|
};
|
|
99
112
|
"#8B77EE": {
|
|
100
|
-
|
|
113
|
+
getValue: (fallback: string) => string;
|
|
101
114
|
token: "var(--ds-chart-purple-bold, #8B77EE)";
|
|
102
115
|
};
|
|
103
116
|
"#8590A2": {
|
|
104
|
-
|
|
117
|
+
getValue: (fallback: string) => string;
|
|
105
118
|
token: "var(--ds-chart-gray-bold, #8590A2)";
|
|
106
119
|
};
|
|
107
120
|
"#0055CC": {
|
|
108
|
-
|
|
121
|
+
getValue: (fallback: string) => string;
|
|
109
122
|
token: "var(--ds-chart-blue-bolder, #0055CC)";
|
|
110
123
|
};
|
|
111
124
|
"#1D7F8C": {
|
|
112
|
-
|
|
125
|
+
getValue: (fallback: string) => string;
|
|
113
126
|
token: "var(--ds-chart-teal-bolder, #1D7F8C)";
|
|
114
127
|
};
|
|
115
128
|
"#177D52": {
|
|
116
|
-
|
|
129
|
+
getValue: (fallback: string) => string;
|
|
117
130
|
token: "var(--ds-chart-green-bolder, #177D52)";
|
|
118
131
|
};
|
|
119
132
|
"#FF9D00": {
|
|
120
|
-
|
|
133
|
+
getValue: (fallback: string) => string;
|
|
121
134
|
token: "var(--ds-chart-yellow-bolder, #FF9D00)";
|
|
122
135
|
};
|
|
123
136
|
"#B65C02": {
|
|
124
|
-
|
|
137
|
+
getValue: (fallback: string) => string;
|
|
125
138
|
token: "var(--ds-chart-orange-bolder, #B65C02)";
|
|
126
139
|
};
|
|
127
140
|
"#D32D03": {
|
|
128
|
-
|
|
141
|
+
getValue: (fallback: string) => string;
|
|
129
142
|
token: "var(--ds-chart-red-bolder, #D32D03)";
|
|
130
143
|
};
|
|
131
144
|
"#CD519D": {
|
|
132
|
-
|
|
145
|
+
getValue: (fallback: string) => string;
|
|
133
146
|
token: "var(--ds-chart-magenta-bolder, #CD519D)";
|
|
134
147
|
};
|
|
135
148
|
"#5A43D0": {
|
|
136
|
-
|
|
149
|
+
getValue: (fallback: string) => string;
|
|
137
150
|
token: "var(--ds-chart-purple-bolder, #5A43D0)";
|
|
138
151
|
};
|
|
139
152
|
"#758195": {
|
|
140
|
-
|
|
153
|
+
getValue: (fallback: string) => string;
|
|
141
154
|
token: "var(--ds-chart-gray-bolder, #758195)";
|
|
142
155
|
};
|
|
143
156
|
"#003884": {
|
|
144
|
-
|
|
157
|
+
getValue: (fallback: string) => string;
|
|
145
158
|
token: "var(--ds-chart-blue-boldest, #003884)";
|
|
146
159
|
};
|
|
147
160
|
"#206B74": {
|
|
148
|
-
|
|
161
|
+
getValue: (fallback: string) => string;
|
|
149
162
|
token: "var(--ds-chart-teal-boldest, #206B74)";
|
|
150
163
|
};
|
|
151
164
|
"#055C3F": {
|
|
152
|
-
|
|
165
|
+
getValue: (fallback: string) => string;
|
|
153
166
|
token: "var(--ds-chart-green-boldest, #055C3F)";
|
|
154
167
|
};
|
|
155
168
|
"#946104": {
|
|
156
|
-
|
|
169
|
+
getValue: (fallback: string) => string;
|
|
157
170
|
token: "var(--ds-chart-yellow-boldest, #946104)";
|
|
158
171
|
};
|
|
159
172
|
"#974F0C": {
|
|
160
|
-
|
|
173
|
+
getValue: (fallback: string) => string;
|
|
161
174
|
token: "var(--ds-chart-orange-boldest, #974F0C)";
|
|
162
175
|
};
|
|
163
176
|
"#A32000": {
|
|
164
|
-
|
|
177
|
+
getValue: (fallback: string) => string;
|
|
165
178
|
token: "var(--ds-chart-red-boldest, #A32000)";
|
|
166
179
|
};
|
|
167
180
|
"#943D73": {
|
|
168
|
-
|
|
181
|
+
getValue: (fallback: string) => string;
|
|
169
182
|
token: "var(--ds-chart-magenta-boldest, #943D73)";
|
|
170
183
|
};
|
|
171
184
|
"#44368B": {
|
|
172
|
-
|
|
185
|
+
getValue: (fallback: string) => string;
|
|
173
186
|
token: "var(--ds-chart-purple-boldest, #44368B)";
|
|
174
187
|
};
|
|
175
188
|
"#44546F": {
|
|
176
|
-
|
|
189
|
+
getValue: (fallback: string) => string;
|
|
177
190
|
token: "var(--ds-chart-gray-boldest, #44546F)";
|
|
178
191
|
};
|
|
179
192
|
};
|
|
180
|
-
declare const tokenNames: ("color.background.accent.blue.subtle" | "color.background.accent.teal.subtle" | "color.background.accent.green.subtle" | "color.background.accent.orange.subtle" | "color.background.accent.red.subtle" | "color.background.accent.purple.subtle" | "color.background.accent.yellow.subtle" | "color.background.accent.magenta.subtle" | "color.background.accent.gray.subtler" | "color.chart.blue.bold" | "color.chart.teal.bold" | "color.chart.green.bold" | "color.chart.yellow.bold" | "color.chart.orange.bold" | "color.chart.red.bold" | "color.chart.magenta.bold" | "color.chart.purple.bold" | "color.chart.gray.bold" | "color.chart.blue.bolder" | "color.chart.teal.bolder" | "color.chart.green.bolder" | "color.chart.yellow.bolder" | "color.chart.orange.bolder" | "color.chart.red.bolder" | "color.chart.magenta.bolder" | "color.chart.purple.bolder" | "color.chart.gray.bolder" | "color.chart.blue.boldest" | "color.chart.teal.boldest" | "color.chart.green.boldest" | "color.chart.yellow.boldest" | "color.chart.orange.boldest" | "color.chart.red.boldest" | "color.chart.magenta.boldest" | "color.chart.purple.boldest" | "color.chart.gray.boldest")[];
|
|
181
|
-
export type EditorBackgroundPaletteTokenNames = (typeof tokenNames)[number];
|
|
182
193
|
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-palette",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"description": "The editor palette",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
},
|
|
10
10
|
"atlassian": {
|
|
11
11
|
"team": "Editor",
|
|
12
|
-
"releaseModel": "
|
|
12
|
+
"releaseModel": "continuous",
|
|
13
13
|
"website": {
|
|
14
14
|
"name": "Editor Palette"
|
|
15
15
|
}
|
|
@@ -33,15 +33,13 @@
|
|
|
33
33
|
".": "./src/index.ts"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
+
"@atlaskit/tokens": "^1.4.0",
|
|
36
37
|
"@babel/runtime": "^7.0.0"
|
|
37
38
|
},
|
|
38
39
|
"devDependencies": {
|
|
39
40
|
"@atlaskit/docs": "*",
|
|
40
41
|
"@atlaskit/section-message": "^6.4.0",
|
|
41
|
-
"@atlaskit/
|
|
42
|
-
"@atlaskit/tokens": "^1.4.0",
|
|
43
|
-
"@atlaskit/visual-regression": "*",
|
|
44
|
-
"@atlaskit/webdriver-runner": "*",
|
|
42
|
+
"@atlaskit/tokens": "^1.5.0",
|
|
45
43
|
"@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
|
|
46
44
|
"@testing-library/react": "^12.1.5",
|
|
47
45
|
"react": "^16.8.0",
|