@zohodesk/components 1.0.0-temp-259.2 → 1.0.0-temp-259.3
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 +4 -0
- package/README.md +21 -3
- package/es/v1/Button/Button.js +3 -2
- package/es/v1/Button/README.md +106 -43
- package/es/v1/Button/__tests__/Button.spec.js +128 -45
- package/es/v1/Button/__tests__/__snapshots__/Button.spec.js.snap +841 -148
- package/es/v1/Button/constants/presets.js +15 -13
- package/es/v1/Button/css/Button_v1.module.css +0 -4
- package/es/v1/helpers/colorHelpers/__tests__/colorHelper.spec.js +357 -0
- package/es/v1/helpers/colorHelpers/index.js +0 -1
- package/lib/v1/Button/Button.js +3 -2
- package/lib/v1/Button/README.md +106 -43
- package/lib/v1/Button/__tests__/Button.spec.js +172 -79
- package/lib/v1/Button/__tests__/__snapshots__/Button.spec.js.snap +841 -148
- package/lib/v1/Button/constants/presets.js +25 -23
- package/lib/v1/Button/css/Button_v1.module.css +0 -4
- package/lib/v1/helpers/colorHelpers/__tests__/colorHelper.spec.js +363 -0
- package/lib/v1/helpers/colorHelpers/index.js +2 -24
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** Button appearance presets */
|
|
2
|
-
export const
|
|
2
|
+
export const BRAND_GHOST = {
|
|
3
3
|
palette: 'brand',
|
|
4
4
|
appearance: {
|
|
5
5
|
bg: false,
|
|
@@ -14,7 +14,7 @@ export const BRAND_OUTLINE = {
|
|
|
14
14
|
border: true
|
|
15
15
|
}
|
|
16
16
|
};
|
|
17
|
-
export const
|
|
17
|
+
export const BRAND_TEXT_ONLY = {
|
|
18
18
|
palette: 'brand',
|
|
19
19
|
appearance: {
|
|
20
20
|
bg: false
|
|
@@ -38,7 +38,7 @@ export const BRAND_TINTED_OUTLINE = {
|
|
|
38
38
|
border: true
|
|
39
39
|
}
|
|
40
40
|
};
|
|
41
|
-
export const
|
|
41
|
+
export const SUCCESS_GHOST = {
|
|
42
42
|
palette: 'success',
|
|
43
43
|
appearance: {
|
|
44
44
|
bg: false,
|
|
@@ -53,7 +53,7 @@ export const SUCCESS_OUTLINE = {
|
|
|
53
53
|
border: true
|
|
54
54
|
}
|
|
55
55
|
};
|
|
56
|
-
export const
|
|
56
|
+
export const SUCCESS_TEXT_ONLY = {
|
|
57
57
|
palette: 'success',
|
|
58
58
|
appearance: {
|
|
59
59
|
bg: false
|
|
@@ -77,23 +77,25 @@ export const SUCCESS_TINTED_OUTLINE = {
|
|
|
77
77
|
border: true
|
|
78
78
|
}
|
|
79
79
|
};
|
|
80
|
-
export const
|
|
80
|
+
export const SECONDARY_GHOST_BRAND_TINTED_ONSELECT = {
|
|
81
81
|
palette: 'secondary',
|
|
82
82
|
appearance: {
|
|
83
83
|
bg: false,
|
|
84
|
-
border: true
|
|
84
|
+
border: true,
|
|
85
|
+
text: 'black'
|
|
85
86
|
},
|
|
86
87
|
hoverAppearance: {
|
|
87
88
|
bg: false,
|
|
88
|
-
border: true
|
|
89
|
+
border: true,
|
|
90
|
+
text: 'black'
|
|
89
91
|
},
|
|
90
92
|
selectedAppearance: {
|
|
93
|
+
bg: 'brandLighter',
|
|
91
94
|
border: 'brandLighter',
|
|
92
|
-
text: '
|
|
93
|
-
bg: 'brandLighter'
|
|
95
|
+
text: 'black'
|
|
94
96
|
}
|
|
95
97
|
};
|
|
96
|
-
export const
|
|
98
|
+
export const BLACK_TEXT_BRAND_ONHOVER = {
|
|
97
99
|
palette: 'brand',
|
|
98
100
|
appearance: {
|
|
99
101
|
bg: false,
|
|
@@ -106,7 +108,7 @@ export const BLACK_GHOST = {
|
|
|
106
108
|
bg: false
|
|
107
109
|
}
|
|
108
110
|
};
|
|
109
|
-
export const
|
|
111
|
+
export const BRAND_BG_ONSELECT = {
|
|
110
112
|
palette: 'brand',
|
|
111
113
|
appearance: {
|
|
112
114
|
bg: false,
|
|
@@ -117,7 +119,7 @@ export const BRAND_OUTLINE_NO_SELECT = {
|
|
|
117
119
|
border: true
|
|
118
120
|
}
|
|
119
121
|
};
|
|
120
|
-
export const
|
|
122
|
+
export const BRAND_TEXT_TINTED_HOVER = {
|
|
121
123
|
palette: 'brandLighter',
|
|
122
124
|
appearance: {
|
|
123
125
|
bg: false
|
|
@@ -130,7 +132,7 @@ export const GHOST_TINTED_HOVER = {
|
|
|
130
132
|
bg: true
|
|
131
133
|
}
|
|
132
134
|
};
|
|
133
|
-
export const
|
|
135
|
+
export const BRAND_TEXT_TINTED_DANGER_HOVER = {
|
|
134
136
|
palette: 'brandLighter',
|
|
135
137
|
appearance: {
|
|
136
138
|
bg: false
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
import getPaletteClasses from "../colorHelper";
|
|
2
|
+
import { PALETTE_CONFIG } from "../constants";
|
|
3
|
+
const ALL_KEYS = ['bg', 'selectedBg', 'hoverBg', 'focusBg', 'activeBg', 'text', 'selectedText', 'hoverText', 'focusText', 'activeText', 'border', 'selectedBorder', 'hoverBorder', 'focusBorder', 'activeBorder'];
|
|
4
|
+
describe('getPaletteClasses', () => {
|
|
5
|
+
// --- Return shape ---
|
|
6
|
+
it('returns an object with all 15 expected keys', () => {
|
|
7
|
+
const result = getPaletteClasses({});
|
|
8
|
+
expect(Object.keys(result)).toEqual(expect.arrayContaining(ALL_KEYS));
|
|
9
|
+
expect(Object.keys(result)).toHaveLength(15);
|
|
10
|
+
}); // --- Default / empty inputs ---
|
|
11
|
+
|
|
12
|
+
it('returns empty strings for all keys when called with no palette or appearance', () => {
|
|
13
|
+
const result = getPaletteClasses({});
|
|
14
|
+
ALL_KEYS.forEach(key => {
|
|
15
|
+
expect(result[key]).toBe('');
|
|
16
|
+
});
|
|
17
|
+
});
|
|
18
|
+
it('returns empty strings for all keys when called with undefined arguments', () => {
|
|
19
|
+
const result = getPaletteClasses({
|
|
20
|
+
palette: undefined,
|
|
21
|
+
appearance: undefined,
|
|
22
|
+
hoverAppearance: undefined,
|
|
23
|
+
selectedAppearance: undefined
|
|
24
|
+
});
|
|
25
|
+
ALL_KEYS.forEach(key => {
|
|
26
|
+
expect(result[key]).toBe('');
|
|
27
|
+
});
|
|
28
|
+
}); // --- Base appearance (bg) ---
|
|
29
|
+
|
|
30
|
+
it('returns a non-empty bg class when palette and appearance.bg=true are provided', () => {
|
|
31
|
+
const result = getPaletteClasses({
|
|
32
|
+
palette: 'brand',
|
|
33
|
+
appearance: {
|
|
34
|
+
bg: true
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
expect(result.bg).toBe('bg-brand-80');
|
|
38
|
+
});
|
|
39
|
+
it('returns lighter bg shade when palette is brandLighter and appearance.bg=true', () => {
|
|
40
|
+
const result = getPaletteClasses({
|
|
41
|
+
palette: 'brandLighter',
|
|
42
|
+
appearance: {
|
|
43
|
+
bg: true
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
expect(result.bg).toBe('bg-brand-10');
|
|
47
|
+
});
|
|
48
|
+
it('returns correct bg class for info palette', () => {
|
|
49
|
+
const result = getPaletteClasses({
|
|
50
|
+
palette: 'info',
|
|
51
|
+
appearance: {
|
|
52
|
+
bg: true
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
expect(result.bg).toBe('bg-blue-80');
|
|
56
|
+
});
|
|
57
|
+
it('returns correct bg class for secondary palette', () => {
|
|
58
|
+
const result = getPaletteClasses({
|
|
59
|
+
palette: 'secondary',
|
|
60
|
+
appearance: {
|
|
61
|
+
bg: true
|
|
62
|
+
}
|
|
63
|
+
});
|
|
64
|
+
expect(result.bg).toBe('bg-grey-65');
|
|
65
|
+
});
|
|
66
|
+
it('returns correct bg class for danger palette', () => {
|
|
67
|
+
const result = getPaletteClasses({
|
|
68
|
+
palette: 'danger',
|
|
69
|
+
appearance: {
|
|
70
|
+
bg: true
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
expect(result.bg).toBe('bg-red-70');
|
|
74
|
+
});
|
|
75
|
+
it('returns correct bg class for success palette', () => {
|
|
76
|
+
const result = getPaletteClasses({
|
|
77
|
+
palette: 'success',
|
|
78
|
+
appearance: {
|
|
79
|
+
bg: true
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
expect(result.bg).toBe('bg-green-80');
|
|
83
|
+
});
|
|
84
|
+
it('returns correct bg class for warning palette', () => {
|
|
85
|
+
const result = getPaletteClasses({
|
|
86
|
+
palette: 'warning',
|
|
87
|
+
appearance: {
|
|
88
|
+
bg: true
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
expect(result.bg).toBe('bg-orange-80');
|
|
92
|
+
}); // --- BG_BORDER_INVALID filtering ---
|
|
93
|
+
|
|
94
|
+
it('returns empty bg when appearance.bg is "black" (BG_BORDER_INVALID)', () => {
|
|
95
|
+
const result = getPaletteClasses({
|
|
96
|
+
palette: 'brand',
|
|
97
|
+
appearance: {
|
|
98
|
+
bg: 'black'
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
expect(result.bg).toBe('');
|
|
102
|
+
});
|
|
103
|
+
it('returns empty bg when appearance.bg is "white" (BG_BORDER_INVALID)', () => {
|
|
104
|
+
const result = getPaletteClasses({
|
|
105
|
+
palette: 'brand',
|
|
106
|
+
appearance: {
|
|
107
|
+
bg: 'white'
|
|
108
|
+
}
|
|
109
|
+
});
|
|
110
|
+
expect(result.bg).toBe('');
|
|
111
|
+
});
|
|
112
|
+
it('returns empty border when appearance.border is "black" (BG_BORDER_INVALID)', () => {
|
|
113
|
+
const result = getPaletteClasses({
|
|
114
|
+
palette: 'brand',
|
|
115
|
+
appearance: {
|
|
116
|
+
border: 'black'
|
|
117
|
+
}
|
|
118
|
+
}); // border falls back to transparent when borderConfig is null and state is undefined
|
|
119
|
+
|
|
120
|
+
expect(result.border).toBe('border-transparent');
|
|
121
|
+
}); // --- TEXT_INVALID filtering ---
|
|
122
|
+
|
|
123
|
+
it('returns empty text when appearance.text is "transparent" (TEXT_INVALID)', () => {
|
|
124
|
+
const result = getPaletteClasses({
|
|
125
|
+
palette: 'brand',
|
|
126
|
+
appearance: {
|
|
127
|
+
text: 'transparent'
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
expect(result.text).toBe('');
|
|
131
|
+
}); // --- Border fallback ---
|
|
132
|
+
|
|
133
|
+
it('returns border-transparent when no border appearance is set and state is base', () => {
|
|
134
|
+
const result = getPaletteClasses({
|
|
135
|
+
palette: 'brand',
|
|
136
|
+
appearance: {
|
|
137
|
+
bg: true
|
|
138
|
+
}
|
|
139
|
+
});
|
|
140
|
+
expect(result.border).toBe('border-transparent');
|
|
141
|
+
});
|
|
142
|
+
it('returns empty hoverBorder when hoverAppearance has no border and bg only', () => {
|
|
143
|
+
const result = getPaletteClasses({
|
|
144
|
+
palette: 'brand',
|
|
145
|
+
appearance: {
|
|
146
|
+
bg: true
|
|
147
|
+
},
|
|
148
|
+
hoverAppearance: {
|
|
149
|
+
bg: true
|
|
150
|
+
}
|
|
151
|
+
}); // state is 'hover', no borderConfig → empty string (state branch)
|
|
152
|
+
|
|
153
|
+
expect(result.hoverBorder).toBe('');
|
|
154
|
+
}); // --- Hover appearance ---
|
|
155
|
+
|
|
156
|
+
it('returns hover-state bg classes for hoverAppearance.bg=true with same palette tone', () => {
|
|
157
|
+
const result = getPaletteClasses({
|
|
158
|
+
palette: 'brand',
|
|
159
|
+
appearance: {
|
|
160
|
+
bg: true
|
|
161
|
+
},
|
|
162
|
+
hoverAppearance: {
|
|
163
|
+
bg: true
|
|
164
|
+
}
|
|
165
|
+
}); // isContinuingTone is true (same tone, same isLighter), so darker=true → hover shade (100)
|
|
166
|
+
|
|
167
|
+
expect(result.hoverBg).toBe('hover:bg-brand-100');
|
|
168
|
+
expect(result.focusBg).toBe('focus:bg-brand-100');
|
|
169
|
+
expect(result.activeBg).toBe('active:bg-brand-100');
|
|
170
|
+
});
|
|
171
|
+
it('returns hover bg from a different palette tone (no isContinuingTone)', () => {
|
|
172
|
+
const result = getPaletteClasses({
|
|
173
|
+
palette: 'brand',
|
|
174
|
+
appearance: {
|
|
175
|
+
bg: true
|
|
176
|
+
},
|
|
177
|
+
hoverAppearance: {
|
|
178
|
+
bg: 'info'
|
|
179
|
+
}
|
|
180
|
+
}); // hoverAppearance.bg='info' → resolveConfig('info', paletteConfig) → PALETTE_CONFIG['info']
|
|
181
|
+
// tone='blue', isLighter=false, isContinuingTone=false → base shade (80)
|
|
182
|
+
|
|
183
|
+
expect(result.hoverBg).toBe('hover:bg-blue-80');
|
|
184
|
+
});
|
|
185
|
+
it('returns empty hover classes when hoverAppearance is not provided', () => {
|
|
186
|
+
const result = getPaletteClasses({
|
|
187
|
+
palette: 'brand',
|
|
188
|
+
appearance: {
|
|
189
|
+
bg: true
|
|
190
|
+
}
|
|
191
|
+
});
|
|
192
|
+
expect(result.hoverBg).toBe('');
|
|
193
|
+
expect(result.focusBg).toBe('');
|
|
194
|
+
expect(result.activeBg).toBe('');
|
|
195
|
+
}); // --- Selected appearance ---
|
|
196
|
+
|
|
197
|
+
it('returns selected-state bg when selectedAppearance.bg=true', () => {
|
|
198
|
+
const result = getPaletteClasses({
|
|
199
|
+
palette: 'brand',
|
|
200
|
+
appearance: {
|
|
201
|
+
bg: true
|
|
202
|
+
},
|
|
203
|
+
selectedAppearance: {
|
|
204
|
+
bg: true
|
|
205
|
+
}
|
|
206
|
+
});
|
|
207
|
+
expect(result.selectedBg).toBe('selected:bg-brand-80');
|
|
208
|
+
});
|
|
209
|
+
it('returns empty selected classes when selectedAppearance is not provided', () => {
|
|
210
|
+
const result = getPaletteClasses({
|
|
211
|
+
palette: 'brand',
|
|
212
|
+
appearance: {
|
|
213
|
+
bg: true
|
|
214
|
+
}
|
|
215
|
+
});
|
|
216
|
+
expect(result.selectedBg).toBe('');
|
|
217
|
+
expect(result.selectedText).toBe('');
|
|
218
|
+
expect(result.selectedBorder).toBe('');
|
|
219
|
+
}); // --- Text classes ---
|
|
220
|
+
|
|
221
|
+
it('returns text class when appearance.text=true and palette has a textTone', () => {
|
|
222
|
+
const result = getPaletteClasses({
|
|
223
|
+
palette: 'brand',
|
|
224
|
+
appearance: {
|
|
225
|
+
text: true
|
|
226
|
+
}
|
|
227
|
+
}); // resolveConfig(true, paletteConfig) → { ...paletteConfig, isInherit: true }
|
|
228
|
+
// resolveTextTone: isInherit=true, bgConfig=null (no bg in appearance), uses textTone='brand'
|
|
229
|
+
|
|
230
|
+
expect(result.text).toBe('text-brand-80');
|
|
231
|
+
});
|
|
232
|
+
it('returns filled text tone when bg is present and palette is not lighter', () => {
|
|
233
|
+
const result = getPaletteClasses({
|
|
234
|
+
palette: 'info',
|
|
235
|
+
appearance: {
|
|
236
|
+
bg: true,
|
|
237
|
+
text: true
|
|
238
|
+
}
|
|
239
|
+
}); // bgConfig is present (tone='blue', isLighter=false), textConfig.isInherit=true
|
|
240
|
+
// resolveTextTone: not isLighter → filledTextTone='white'
|
|
241
|
+
// getTextClass(undefined, 'white', ...) → TONE_INTENSITY['white'] is undefined
|
|
242
|
+
// → paletteTextStyle['text-white'] → 'text-white'
|
|
243
|
+
|
|
244
|
+
expect(result.text).toBe('text-white');
|
|
245
|
+
});
|
|
246
|
+
it('returns lighter text tone when palette is lighter and bg is present', () => {
|
|
247
|
+
const result = getPaletteClasses({
|
|
248
|
+
palette: 'infoLighter',
|
|
249
|
+
appearance: {
|
|
250
|
+
bg: true,
|
|
251
|
+
text: true
|
|
252
|
+
}
|
|
253
|
+
}); // bgConfig.isLighter=true → filledTextTone='blue' → getTextClass for 'blue'
|
|
254
|
+
// TONE_INTENSITY['blue'] = { base: 80, ... } → shade=80
|
|
255
|
+
|
|
256
|
+
expect(result.text).toBe('text-blue-80');
|
|
257
|
+
}); // --- Border classes ---
|
|
258
|
+
|
|
259
|
+
it('returns base border shade when appearance.border=true (isLighter=false)', () => {
|
|
260
|
+
const result = getPaletteClasses({
|
|
261
|
+
palette: 'brand',
|
|
262
|
+
appearance: {
|
|
263
|
+
border: true
|
|
264
|
+
}
|
|
265
|
+
}); // tone='brand', isLighter=false, darker=false → shade = intensity.base = 80
|
|
266
|
+
|
|
267
|
+
expect(result.border).toBe('border-brand-80');
|
|
268
|
+
});
|
|
269
|
+
it('returns borderLight shade when appearance.border=true on lighter palette', () => {
|
|
270
|
+
const result = getPaletteClasses({
|
|
271
|
+
palette: 'brandLighter',
|
|
272
|
+
appearance: {
|
|
273
|
+
border: true
|
|
274
|
+
}
|
|
275
|
+
}); // tone='brand', isLighter=true, darker=false → shade = intensity.borderLight = 10
|
|
276
|
+
|
|
277
|
+
expect(result.border).toBe('border-brand-10');
|
|
278
|
+
}); // --- Custom tone (not in TONE_INTENSITY) ---
|
|
279
|
+
|
|
280
|
+
it('returns empty bg when appearance.bg uses a tone not in TONE_INTENSITY and not in CSS', () => {
|
|
281
|
+
const result = getPaletteClasses({
|
|
282
|
+
appearance: {
|
|
283
|
+
bg: 'custom-tone'
|
|
284
|
+
}
|
|
285
|
+
}); // PALETTE_CONFIG['custom-tone'] is undefined, resolveConfig returns { tone: 'custom-tone', ... }
|
|
286
|
+
// TONE_INTENSITY['custom-tone'] is undefined → looks up paletteBgStyle['bg-custom-tone']
|
|
287
|
+
// That class is not in the CSS file → undefined → falls back to ''
|
|
288
|
+
|
|
289
|
+
expect(result.bg).toBe('');
|
|
290
|
+
}); // --- Each PALETTE_CONFIG key produces a valid (non-error) result ---
|
|
291
|
+
|
|
292
|
+
it.each(Object.keys(PALETTE_CONFIG))('does not throw for palette "%s" with all appearances set', palette => {
|
|
293
|
+
expect(() => {
|
|
294
|
+
getPaletteClasses({
|
|
295
|
+
palette,
|
|
296
|
+
appearance: {
|
|
297
|
+
bg: true,
|
|
298
|
+
border: true,
|
|
299
|
+
text: true
|
|
300
|
+
},
|
|
301
|
+
hoverAppearance: {
|
|
302
|
+
bg: true,
|
|
303
|
+
border: true,
|
|
304
|
+
text: true
|
|
305
|
+
},
|
|
306
|
+
selectedAppearance: {
|
|
307
|
+
bg: true,
|
|
308
|
+
border: true,
|
|
309
|
+
text: true
|
|
310
|
+
}
|
|
311
|
+
});
|
|
312
|
+
}).not.toThrow();
|
|
313
|
+
});
|
|
314
|
+
it.each(Object.keys(PALETTE_CONFIG))('returns an object with all 15 keys for palette "%s"', palette => {
|
|
315
|
+
const result = getPaletteClasses({
|
|
316
|
+
palette,
|
|
317
|
+
appearance: {
|
|
318
|
+
bg: true,
|
|
319
|
+
border: true,
|
|
320
|
+
text: true
|
|
321
|
+
},
|
|
322
|
+
hoverAppearance: {
|
|
323
|
+
bg: true
|
|
324
|
+
},
|
|
325
|
+
selectedAppearance: {
|
|
326
|
+
bg: true
|
|
327
|
+
}
|
|
328
|
+
});
|
|
329
|
+
expect(Object.keys(result)).toHaveLength(15);
|
|
330
|
+
}); // --- Full appearance object (bg + border + text together) ---
|
|
331
|
+
|
|
332
|
+
it('populates bg, text, and border simultaneously when all appearance fields are set', () => {
|
|
333
|
+
const result = getPaletteClasses({
|
|
334
|
+
palette: 'brand',
|
|
335
|
+
appearance: {
|
|
336
|
+
bg: true,
|
|
337
|
+
border: true,
|
|
338
|
+
text: true
|
|
339
|
+
}
|
|
340
|
+
});
|
|
341
|
+
expect(result.bg).not.toBe('');
|
|
342
|
+
expect(result.border).not.toBe('');
|
|
343
|
+
expect(result.text).not.toBe('');
|
|
344
|
+
}); // --- Appearance with bg=false (falsy) ---
|
|
345
|
+
|
|
346
|
+
it('returns empty bg when appearance.bg is false', () => {
|
|
347
|
+
const result = getPaletteClasses({
|
|
348
|
+
palette: 'brand',
|
|
349
|
+
appearance: {
|
|
350
|
+
bg: false,
|
|
351
|
+
border: true
|
|
352
|
+
}
|
|
353
|
+
});
|
|
354
|
+
expect(result.bg).toBe('');
|
|
355
|
+
expect(result.border).not.toBe('');
|
|
356
|
+
});
|
|
357
|
+
});
|
package/lib/v1/Button/Button.js
CHANGED
|
@@ -241,7 +241,8 @@ var Button = /*#__PURE__*/(0, _react.forwardRef)(function Button(props, ref) {
|
|
|
241
241
|
a11yAttributes = props.a11yAttributes,
|
|
242
242
|
customId = props.customId,
|
|
243
243
|
testId = props.testId,
|
|
244
|
-
dataSelectorId = props.dataSelectorId
|
|
244
|
+
dataSelectorId = props.dataSelectorId,
|
|
245
|
+
customClass = props.customClass;
|
|
245
246
|
var isLoading = status === _constants2.STATUS.LOADING;
|
|
246
247
|
var isSuccess = status === _constants2.STATUS.SUCCESS;
|
|
247
248
|
var isDisabledState = isDisabled || isLoading;
|
|
@@ -250,7 +251,7 @@ var Button = /*#__PURE__*/(0, _react.forwardRef)(function Button(props, ref) {
|
|
|
250
251
|
return (0, _cssJSLogic["default"])({
|
|
251
252
|
props: props
|
|
252
253
|
});
|
|
253
|
-
}, [palette, appearance, hoverAppearance, selectedAppearance, size, variant, status, isDisabled, isSelected, shape, loaderPlacement, disabledAppearance,
|
|
254
|
+
}, [palette, appearance, hoverAppearance, selectedAppearance, size, variant, status, isDisabled, isSelected, shape, loaderPlacement, disabledAppearance, customClass]);
|
|
254
255
|
|
|
255
256
|
var handleClick = function handleClick(event) {
|
|
256
257
|
if (isDisabledState) return;
|
package/lib/v1/Button/README.md
CHANGED
|
@@ -18,14 +18,49 @@ import Button from '@zohodesk/components/es/v1/Button/Button';
|
|
|
18
18
|
</Button>
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
### With Palette
|
|
21
|
+
### With Palette
|
|
22
22
|
|
|
23
23
|
```jsx
|
|
24
|
-
<Button palette="
|
|
24
|
+
<Button palette="brand">Save</Button>
|
|
25
25
|
<Button palette="danger">Delete</Button>
|
|
26
26
|
<Button palette="success">Confirm</Button>
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
+
### With Appearance
|
|
30
|
+
|
|
31
|
+
`appearance`, `hoverAppearance`, and `selectedAppearance` are objects with optional `bg`, `border`, and `text` keys. Each key accepts `true` (use palette color), `false` (suppress), or a palette name string.
|
|
32
|
+
|
|
33
|
+
```jsx
|
|
34
|
+
<Button palette="brand" appearance={{ bg: false, border: true }}>
|
|
35
|
+
Ghost
|
|
36
|
+
</Button>
|
|
37
|
+
|
|
38
|
+
<Button
|
|
39
|
+
palette="brand"
|
|
40
|
+
appearance={{ bg: false, border: true }}
|
|
41
|
+
hoverAppearance={{ bg: false, border: true }}
|
|
42
|
+
selectedAppearance={{ bg: false, border: true }}
|
|
43
|
+
>
|
|
44
|
+
Ghost with states
|
|
45
|
+
</Button>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Using Presets
|
|
49
|
+
|
|
50
|
+
```jsx
|
|
51
|
+
import {
|
|
52
|
+
BRAND_GHOST,
|
|
53
|
+
BRAND_TEXT_ONLY,
|
|
54
|
+
SECONDARY_GHOST_BRAND_TINTED_ONSELECT,
|
|
55
|
+
BRAND_TINTED_OUTLINE,
|
|
56
|
+
BRAND_TEXT_TINTED_HOVER
|
|
57
|
+
} from '@zohodesk/components/es/v1/Button/constants/presets';
|
|
58
|
+
|
|
59
|
+
<Button {...BRAND_GHOST}>Brand Ghost</Button>
|
|
60
|
+
<Button {...BRAND_TEXT_ONLY}>Brand Text Only</Button>
|
|
61
|
+
<Button {...SECONDARY_GHOST_BRAND_TINTED_ONSELECT}>Secondary Ghost</Button>
|
|
62
|
+
```
|
|
63
|
+
|
|
29
64
|
### With Icon
|
|
30
65
|
|
|
31
66
|
```jsx
|
|
@@ -36,76 +71,104 @@ import Button from '@zohodesk/components/es/v1/Button/Button';
|
|
|
36
71
|
</Button>
|
|
37
72
|
```
|
|
38
73
|
|
|
39
|
-
### Loading State
|
|
74
|
+
### Loading / Success State
|
|
40
75
|
|
|
41
76
|
```jsx
|
|
42
|
-
<Button status="loading" loaderPlacement="overlay">
|
|
43
|
-
|
|
44
|
-
</Button>
|
|
45
|
-
|
|
46
|
-
<Button status="loading" loaderPlacement="start">
|
|
47
|
-
Loading
|
|
48
|
-
</Button>
|
|
77
|
+
<Button status="loading" loaderPlacement="overlay">Saving...</Button>
|
|
78
|
+
<Button status="loading" loaderPlacement="start">Loading</Button>
|
|
79
|
+
<Button status="success">Done</Button>
|
|
49
80
|
```
|
|
50
81
|
|
|
51
|
-
### Disabled
|
|
82
|
+
### Disabled
|
|
52
83
|
|
|
53
84
|
```jsx
|
|
54
85
|
<Button isDisabled>Disabled</Button>
|
|
55
|
-
<Button
|
|
86
|
+
<Button isDisabled disabledAppearance="strike">Disabled Strike</Button>
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Shape
|
|
90
|
+
|
|
91
|
+
```jsx
|
|
92
|
+
<Button shape="pill">Pill</Button>
|
|
93
|
+
<Button shape="rectangle">Rectangle</Button>
|
|
94
|
+
<Button shape="roundedRectangle">Rounded</Button>
|
|
56
95
|
```
|
|
57
96
|
|
|
58
97
|
## Props
|
|
59
98
|
|
|
60
99
|
| Prop | Type | Default | Description |
|
|
61
100
|
|---|---|---|---|
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `hoverAppearance` | `array of: border, text, bg` | `['bg', 'border']` | Which treatments are colored on hover/focus/active |
|
|
67
|
-
| `selectedAppearance` | `array of: border, text, bg` | `['bg', 'border']` | Which treatments are colored when `isSelected` |
|
|
101
|
+
| `palette` | `oneOf: brand, brandLighter, info, infoLighter, secondary, secondaryLighter, danger, dangerLighter, success, successLighter, warning, warningLighter` | `''` | Color palette |
|
|
102
|
+
| `appearance` | `{ bg?, border?, text? }` | `{ bg: true, text: true }` | Color treatments at rest. Values: `true`, `false`, or a palette name |
|
|
103
|
+
| `hoverAppearance` | `{ bg?, border?, text? }` | `{ bg: true, text: true }` | Color treatments on hover/focus/active |
|
|
104
|
+
| `selectedAppearance` | `{ bg?, border?, text? }` | `{ bg: true, text: true }` | Color treatments when `isSelected` is true |
|
|
68
105
|
| `variant` | `oneOf: text, icon, iconWithText` | `text` | Display variant |
|
|
69
106
|
| `size` | `oneOf: small, medium, large, full` | `medium` | Size variant |
|
|
70
107
|
| `status` | `oneOf: default, loading, success` | `default` | Status state |
|
|
71
|
-
| `loaderPlacement` | `oneOf: start, end, overlay` | `overlay` | Where loader appears |
|
|
108
|
+
| `loaderPlacement` | `oneOf: start, end, overlay` | `overlay` | Where the loader appears |
|
|
109
|
+
| `shape` | `oneOf: pill, rectangle, roundedRectangle` | `roundedRectangle` | Border shape |
|
|
72
110
|
| `iconName` | `string` | — | Icon name from `@zohodesk/icons` |
|
|
73
111
|
| `iconSize` | `number` | `16` | Icon size in pixels |
|
|
74
112
|
| `iconPlacement` | `oneOf: left, right` | `left` | Icon position relative to text |
|
|
75
|
-
| `
|
|
76
|
-
| `
|
|
113
|
+
| `disabledAppearance` | `oneOf: none, dull, strike` | `dull` | Visual style when disabled |
|
|
114
|
+
| `isDisabled` | `bool` | `false` | Disables the button |
|
|
115
|
+
| `isSelected` | `bool` | `false` | Selected/pressed state (`aria-pressed`) |
|
|
116
|
+
| `type` | `oneOf: button, submit, reset` | `button` | HTML button type |
|
|
117
|
+
| `onClick` | `func` | — | Click handler (suppressed when disabled or loading) |
|
|
118
|
+
| `title` | `string` | — | Tooltip / `data-title` attribute |
|
|
119
|
+
| `children` | `node` | — | Button label content |
|
|
77
120
|
| `renderIcon` | `node \| func` | — | Custom icon render slot |
|
|
78
121
|
| `renderBefore` | `node \| func` | — | Slot before main content |
|
|
79
122
|
| `renderAfter` | `node \| func` | — | Slot after main content |
|
|
80
123
|
| `renderLoader` | `node \| func` | — | Custom loader render slot |
|
|
81
124
|
| `renderSuccess` | `node \| func` | — | Custom success render slot |
|
|
82
|
-
| `
|
|
83
|
-
| `
|
|
84
|
-
| `
|
|
85
|
-
| `
|
|
86
|
-
| `
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
89
|
-
|
|
125
|
+
| `customId` | `string` | — | `data-id` attribute |
|
|
126
|
+
| `testId` | `string` | — | `data-test-id` attribute |
|
|
127
|
+
| `dataSelectorId` | `string` | — | `data-selector-id` attribute |
|
|
128
|
+
| `a11yAttributes` | `object` | `{}` | Extra ARIA/accessibility attributes spread onto `<button>` |
|
|
129
|
+
| `customClass` | `{ wrapper?, text?, icon?, loader?, success? }` | `{}` | CSS class overrides per part |
|
|
130
|
+
| `customProps` | `{ text?, icon? }` | `{}` | Extra props forwarded to text/icon sub-elements |
|
|
131
|
+
| `customAttributes` | `{ button?, contentWrapper?, loader?, success?, icon?, text? }` | `{}` | Extra HTML attributes per internal element |
|
|
132
|
+
|
|
133
|
+
## Presets
|
|
134
|
+
|
|
135
|
+
Ready-made palette + appearance combinations exported from `constants/presets`:
|
|
136
|
+
|
|
137
|
+
| Name | Palette | Appearance | Description |
|
|
138
|
+
|---|---|---|---|
|
|
139
|
+
| `BRAND_GHOST` | `brand` | `{ bg: false, border: true }` | Transparent bg, brand border |
|
|
140
|
+
| `BRAND_TEXT_ONLY` | `brand` | `{ bg: false }` | Text only, no border |
|
|
141
|
+
| `BRAND_TINTED_OUTLINE` | `brandLighter` | `{ border: true }` | Tinted fill, brand border |
|
|
142
|
+
| `SUCCESS_GHOST` | `success` | `{ bg: false, border: true }` | Transparent bg, success border |
|
|
143
|
+
| `SUCCESS_TEXT_ONLY` | `success` | `{ bg: false }` | Text only, no border |
|
|
144
|
+
| `SUCCESS_TINTED_OUTLINE` | `successLighter` | `{ border: true }` | Tinted fill, success border |
|
|
145
|
+
| `SECONDARY_GHOST_BRAND_TINTED_ONSELECT` | `secondary` | `{ bg: false, border: true }` | Secondary ghost; selected state switches to brand tint |
|
|
146
|
+
| `BLACK_TEXT_BRAND_ONHOVER` | `brand` | `{ bg: false, text: 'black' }` | Black text, brand color on hover |
|
|
147
|
+
| `BRAND_BG_ONSELECT` | `brand` | `{ bg: false, border: true }` | Ghost without a defined selected state |
|
|
148
|
+
| `BRAND_TEXT_TINTED_HOVER` | `brandLighter` | `{ bg: false }` | Ghost that becomes tinted on hover |
|
|
149
|
+
| `BRAND_TEXT_TINTED_DANGER_HOVER` | `brandLighter` | `{ bg: false }` | Ghost that becomes danger-tinted on hover |
|
|
90
150
|
|
|
91
151
|
## Customization
|
|
92
152
|
|
|
93
153
|
### Parts
|
|
94
154
|
|
|
95
|
-
| Part | Element | Description |
|
|
155
|
+
| Part key | Element | Description |
|
|
96
156
|
|---|---|---|
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
99
|
-
|
|
100
|
-
|
|
157
|
+
| `button` | `<button>` | Outermost button element |
|
|
158
|
+
| `contentWrapper` | Inner `<Flex>` | Wraps icon + text content |
|
|
159
|
+
| `text` | `<Typography>` | Text label |
|
|
160
|
+
| `icon` | `<Icon>` | Icon element |
|
|
161
|
+
| `loader` | `<Flex>` | Loader wrapper |
|
|
162
|
+
| `success` | `<Flex>` | Success tick wrapper |
|
|
101
163
|
|
|
102
|
-
|
|
164
|
+
Pass class overrides via `customClass`, extra props via `customProps`, or arbitrary HTML attributes via `customAttributes`.
|
|
103
165
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
166
|
+
```jsx
|
|
167
|
+
<Button
|
|
168
|
+
customClass={{ wrapper: 'myBtn', text: 'myBtnText' }}
|
|
169
|
+
customAttributes={{ button: { 'data-analytics': 'save' } }}
|
|
170
|
+
a11yAttributes={{ 'aria-label': 'Save document' }}
|
|
171
|
+
>
|
|
172
|
+
Save
|
|
173
|
+
</Button>
|
|
174
|
+
```
|