context.dev 1.1.0 → 1.2.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.
@@ -42,42 +42,42 @@ module ContextDev
42
42
  # @!attribute colors
43
43
  # Primary colors used on the website
44
44
  #
45
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, nil]
46
- optional :colors, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors }
45
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors]
46
+ required :colors, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors }
47
47
 
48
48
  # @!attribute components
49
49
  # UI component styles
50
50
  #
51
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, nil]
52
- optional :components, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components }
51
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components]
52
+ required :components, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components }
53
53
 
54
54
  # @!attribute element_spacing
55
55
  # Spacing system used on the website
56
56
  #
57
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, nil]
58
- optional :element_spacing,
57
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing]
58
+ required :element_spacing,
59
59
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing },
60
60
  api_name: :elementSpacing
61
61
 
62
62
  # @!attribute mode
63
63
  # The primary color mode of the website design
64
64
  #
65
- # @return [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode, nil]
66
- optional :mode, enum: -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode }
65
+ # @return [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode]
66
+ required :mode, enum: -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode }
67
67
 
68
68
  # @!attribute shadows
69
69
  # Shadow styles used on the website
70
70
  #
71
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, nil]
72
- optional :shadows, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows }
71
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows]
72
+ required :shadows, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows }
73
73
 
74
74
  # @!attribute typography
75
75
  # Typography styles used on the website
76
76
  #
77
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography, nil]
78
- optional :typography, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography }
77
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography]
78
+ required :typography, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography }
79
79
 
80
- # @!method initialize(colors: nil, components: nil, element_spacing: nil, mode: nil, shadows: nil, typography: nil)
80
+ # @!method initialize(colors:, components:, element_spacing:, mode:, shadows:, typography:)
81
81
  # Comprehensive styleguide data extracted from the website
82
82
  #
83
83
  # @param colors [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors] Primary colors used on the website
@@ -95,31 +95,31 @@ module ContextDev
95
95
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#colors
96
96
  class Colors < ContextDev::Internal::Type::BaseModel
97
97
  # @!attribute accent
98
- # Accent color of the website (hex format)
98
+ # Accent color (hex format)
99
99
  #
100
- # @return [String, nil]
101
- optional :accent, String
100
+ # @return [String]
101
+ required :accent, String
102
102
 
103
103
  # @!attribute background
104
- # Background color of the website (hex format)
104
+ # Background color (hex format)
105
105
  #
106
- # @return [String, nil]
107
- optional :background, String
106
+ # @return [String]
107
+ required :background, String
108
108
 
109
109
  # @!attribute text
110
- # Text color of the website (hex format)
110
+ # Text color (hex format)
111
111
  #
112
- # @return [String, nil]
113
- optional :text, String
112
+ # @return [String]
113
+ required :text, String
114
114
 
115
- # @!method initialize(accent: nil, background: nil, text: nil)
115
+ # @!method initialize(accent:, background:, text:)
116
116
  # Primary colors used on the website
117
117
  #
118
- # @param accent [String] Accent color of the website (hex format)
118
+ # @param accent [String] Accent color (hex format)
119
119
  #
120
- # @param background [String] Background color of the website (hex format)
120
+ # @param background [String] Background color (hex format)
121
121
  #
122
- # @param text [String] Text color of the website (hex format)
122
+ # @param text [String] Text color (hex format)
123
123
  end
124
124
 
125
125
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#components
@@ -127,8 +127,8 @@ module ContextDev
127
127
  # @!attribute button
128
128
  # Button component styles
129
129
  #
130
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, nil]
131
- optional :button,
130
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button]
131
+ required :button,
132
132
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button }
133
133
 
134
134
  # @!attribute card
@@ -137,7 +137,7 @@ module ContextDev
137
137
  # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card, nil]
138
138
  optional :card, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card }
139
139
 
140
- # @!method initialize(button: nil, card: nil)
140
+ # @!method initialize(button:, card: nil)
141
141
  # UI component styles
142
142
  #
143
143
  # @param button [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button] Button component styles
@@ -147,21 +147,18 @@ module ContextDev
147
147
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components#button
148
148
  class Button < ContextDev::Internal::Type::BaseModel
149
149
  # @!attribute link
150
- # Link button style
151
150
  #
152
151
  # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, nil]
153
152
  optional :link,
154
153
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link }
155
154
 
156
155
  # @!attribute primary
157
- # Primary button style
158
156
  #
159
157
  # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, nil]
160
158
  optional :primary,
161
159
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary }
162
160
 
163
161
  # @!attribute secondary
164
- # Secondary button style
165
162
  #
166
163
  # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary, nil]
167
164
  optional :secondary,
@@ -170,229 +167,416 @@ module ContextDev
170
167
  # @!method initialize(link: nil, primary: nil, secondary: nil)
171
168
  # Button component styles
172
169
  #
173
- # @param link [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link] Link button style
174
- #
175
- # @param primary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary] Primary button style
176
- #
177
- # @param secondary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary] Secondary button style
170
+ # @param link [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link]
171
+ # @param primary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary]
172
+ # @param secondary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary]
178
173
 
179
174
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#link
180
175
  class Link < ContextDev::Internal::Type::BaseModel
181
176
  # @!attribute background_color
182
177
  #
183
- # @return [String, nil]
184
- optional :background_color, String, api_name: :backgroundColor
178
+ # @return [String]
179
+ required :background_color, String, api_name: :backgroundColor
185
180
 
186
181
  # @!attribute border_color
182
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
183
+ # alpha)
187
184
  #
188
- # @return [String, nil]
189
- optional :border_color, String, api_name: :borderColor
185
+ # @return [String]
186
+ required :border_color, String, api_name: :borderColor
190
187
 
191
188
  # @!attribute border_radius
192
189
  #
193
- # @return [String, nil]
194
- optional :border_radius, String, api_name: :borderRadius
190
+ # @return [String]
191
+ required :border_radius, String, api_name: :borderRadius
195
192
 
196
193
  # @!attribute border_style
197
194
  #
198
- # @return [String, nil]
199
- optional :border_style, String, api_name: :borderStyle
195
+ # @return [String]
196
+ required :border_style, String, api_name: :borderStyle
200
197
 
201
198
  # @!attribute border_width
202
199
  #
203
- # @return [String, nil]
204
- optional :border_width, String, api_name: :borderWidth
200
+ # @return [String]
201
+ required :border_width, String, api_name: :borderWidth
205
202
 
206
203
  # @!attribute box_shadow
204
+ # Computed box-shadow (comma-separated layers when present)
207
205
  #
208
- # @return [String, nil]
209
- optional :box_shadow, String, api_name: :boxShadow
206
+ # @return [String]
207
+ required :box_shadow, String, api_name: :boxShadow
210
208
 
211
209
  # @!attribute color
212
210
  #
213
- # @return [String, nil]
214
- optional :color, String
211
+ # @return [String]
212
+ required :color, String
213
+
214
+ # @!attribute css
215
+ # Ready-to-use CSS declaration block for this component style
216
+ #
217
+ # @return [String]
218
+ required :css, String
215
219
 
216
220
  # @!attribute font_size
217
221
  #
218
- # @return [String, nil]
219
- optional :font_size, String, api_name: :fontSize
222
+ # @return [String]
223
+ required :font_size, String, api_name: :fontSize
220
224
 
221
225
  # @!attribute font_weight
222
226
  #
223
- # @return [Float, nil]
224
- optional :font_weight, Float, api_name: :fontWeight
227
+ # @return [Float]
228
+ required :font_weight, Float, api_name: :fontWeight
229
+
230
+ # @!attribute min_height
231
+ # Sampled minimum height of the button box (typically px)
232
+ #
233
+ # @return [String]
234
+ required :min_height, String, api_name: :minHeight
235
+
236
+ # @!attribute min_width
237
+ # Sampled minimum width of the button box (typically px)
238
+ #
239
+ # @return [String]
240
+ required :min_width, String, api_name: :minWidth
225
241
 
226
242
  # @!attribute padding
227
243
  #
228
- # @return [String, nil]
229
- optional :padding, String
244
+ # @return [String]
245
+ required :padding, String
230
246
 
231
247
  # @!attribute text_decoration
232
248
  #
249
+ # @return [String]
250
+ required :text_decoration, String, api_name: :textDecoration
251
+
252
+ # @!attribute font_fallbacks
253
+ # Full ordered font list from computed font-family
254
+ #
255
+ # @return [Array<String>, nil]
256
+ optional :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
257
+
258
+ # @!attribute font_family
259
+ # Primary button typeface (first in fontFallbacks)
260
+ #
233
261
  # @return [String, nil]
234
- optional :text_decoration, String, api_name: :textDecoration
262
+ optional :font_family, String, api_name: :fontFamily
235
263
 
236
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
237
- # Link button style
264
+ # @!attribute text_decoration_color
265
+ # Hex color of the underline when it differs from the text color
266
+ #
267
+ # @return [String, nil]
268
+ optional :text_decoration_color, String, api_name: :textDecorationColor
269
+
270
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
271
+ # Some parameter documentations has been truncated, see
272
+ # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link}
273
+ # for more details.
238
274
  #
239
275
  # @param background_color [String]
240
- # @param border_color [String]
276
+ #
277
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
278
+ #
241
279
  # @param border_radius [String]
280
+ #
242
281
  # @param border_style [String]
282
+ #
243
283
  # @param border_width [String]
244
- # @param box_shadow [String]
284
+ #
285
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
286
+ #
245
287
  # @param color [String]
288
+ #
289
+ # @param css [String] Ready-to-use CSS declaration block for this component style
290
+ #
246
291
  # @param font_size [String]
292
+ #
247
293
  # @param font_weight [Float]
294
+ #
295
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
296
+ #
297
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
298
+ #
248
299
  # @param padding [String]
300
+ #
249
301
  # @param text_decoration [String]
302
+ #
303
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
304
+ #
305
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
306
+ #
307
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
250
308
  end
251
309
 
252
310
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#primary
253
311
  class Primary < ContextDev::Internal::Type::BaseModel
254
312
  # @!attribute background_color
255
313
  #
256
- # @return [String, nil]
257
- optional :background_color, String, api_name: :backgroundColor
314
+ # @return [String]
315
+ required :background_color, String, api_name: :backgroundColor
258
316
 
259
317
  # @!attribute border_color
318
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
319
+ # alpha)
260
320
  #
261
- # @return [String, nil]
262
- optional :border_color, String, api_name: :borderColor
321
+ # @return [String]
322
+ required :border_color, String, api_name: :borderColor
263
323
 
264
324
  # @!attribute border_radius
265
325
  #
266
- # @return [String, nil]
267
- optional :border_radius, String, api_name: :borderRadius
326
+ # @return [String]
327
+ required :border_radius, String, api_name: :borderRadius
268
328
 
269
329
  # @!attribute border_style
270
330
  #
271
- # @return [String, nil]
272
- optional :border_style, String, api_name: :borderStyle
331
+ # @return [String]
332
+ required :border_style, String, api_name: :borderStyle
273
333
 
274
334
  # @!attribute border_width
275
335
  #
276
- # @return [String, nil]
277
- optional :border_width, String, api_name: :borderWidth
336
+ # @return [String]
337
+ required :border_width, String, api_name: :borderWidth
278
338
 
279
339
  # @!attribute box_shadow
340
+ # Computed box-shadow (comma-separated layers when present)
280
341
  #
281
- # @return [String, nil]
282
- optional :box_shadow, String, api_name: :boxShadow
342
+ # @return [String]
343
+ required :box_shadow, String, api_name: :boxShadow
283
344
 
284
345
  # @!attribute color
285
346
  #
286
- # @return [String, nil]
287
- optional :color, String
347
+ # @return [String]
348
+ required :color, String
349
+
350
+ # @!attribute css
351
+ # Ready-to-use CSS declaration block for this component style
352
+ #
353
+ # @return [String]
354
+ required :css, String
288
355
 
289
356
  # @!attribute font_size
290
357
  #
291
- # @return [String, nil]
292
- optional :font_size, String, api_name: :fontSize
358
+ # @return [String]
359
+ required :font_size, String, api_name: :fontSize
293
360
 
294
361
  # @!attribute font_weight
295
362
  #
296
- # @return [Float, nil]
297
- optional :font_weight, Float, api_name: :fontWeight
363
+ # @return [Float]
364
+ required :font_weight, Float, api_name: :fontWeight
365
+
366
+ # @!attribute min_height
367
+ # Sampled minimum height of the button box (typically px)
368
+ #
369
+ # @return [String]
370
+ required :min_height, String, api_name: :minHeight
371
+
372
+ # @!attribute min_width
373
+ # Sampled minimum width of the button box (typically px)
374
+ #
375
+ # @return [String]
376
+ required :min_width, String, api_name: :minWidth
298
377
 
299
378
  # @!attribute padding
300
379
  #
301
- # @return [String, nil]
302
- optional :padding, String
380
+ # @return [String]
381
+ required :padding, String
303
382
 
304
383
  # @!attribute text_decoration
305
384
  #
385
+ # @return [String]
386
+ required :text_decoration, String, api_name: :textDecoration
387
+
388
+ # @!attribute font_fallbacks
389
+ # Full ordered font list from computed font-family
390
+ #
391
+ # @return [Array<String>, nil]
392
+ optional :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
393
+
394
+ # @!attribute font_family
395
+ # Primary button typeface (first in fontFallbacks)
396
+ #
306
397
  # @return [String, nil]
307
- optional :text_decoration, String, api_name: :textDecoration
398
+ optional :font_family, String, api_name: :fontFamily
399
+
400
+ # @!attribute text_decoration_color
401
+ # Hex color of the underline when it differs from the text color
402
+ #
403
+ # @return [String, nil]
404
+ optional :text_decoration_color, String, api_name: :textDecorationColor
308
405
 
309
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
310
- # Primary button style
406
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
407
+ # Some parameter documentations has been truncated, see
408
+ # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary}
409
+ # for more details.
311
410
  #
312
411
  # @param background_color [String]
313
- # @param border_color [String]
412
+ #
413
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
414
+ #
314
415
  # @param border_radius [String]
416
+ #
315
417
  # @param border_style [String]
418
+ #
316
419
  # @param border_width [String]
317
- # @param box_shadow [String]
420
+ #
421
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
422
+ #
318
423
  # @param color [String]
424
+ #
425
+ # @param css [String] Ready-to-use CSS declaration block for this component style
426
+ #
319
427
  # @param font_size [String]
428
+ #
320
429
  # @param font_weight [Float]
430
+ #
431
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
432
+ #
433
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
434
+ #
321
435
  # @param padding [String]
436
+ #
322
437
  # @param text_decoration [String]
438
+ #
439
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
440
+ #
441
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
442
+ #
443
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
323
444
  end
324
445
 
325
446
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#secondary
326
447
  class Secondary < ContextDev::Internal::Type::BaseModel
327
448
  # @!attribute background_color
328
449
  #
329
- # @return [String, nil]
330
- optional :background_color, String, api_name: :backgroundColor
450
+ # @return [String]
451
+ required :background_color, String, api_name: :backgroundColor
331
452
 
332
453
  # @!attribute border_color
454
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
455
+ # alpha)
333
456
  #
334
- # @return [String, nil]
335
- optional :border_color, String, api_name: :borderColor
457
+ # @return [String]
458
+ required :border_color, String, api_name: :borderColor
336
459
 
337
460
  # @!attribute border_radius
338
461
  #
339
- # @return [String, nil]
340
- optional :border_radius, String, api_name: :borderRadius
462
+ # @return [String]
463
+ required :border_radius, String, api_name: :borderRadius
341
464
 
342
465
  # @!attribute border_style
343
466
  #
344
- # @return [String, nil]
345
- optional :border_style, String, api_name: :borderStyle
467
+ # @return [String]
468
+ required :border_style, String, api_name: :borderStyle
346
469
 
347
470
  # @!attribute border_width
348
471
  #
349
- # @return [String, nil]
350
- optional :border_width, String, api_name: :borderWidth
472
+ # @return [String]
473
+ required :border_width, String, api_name: :borderWidth
351
474
 
352
475
  # @!attribute box_shadow
476
+ # Computed box-shadow (comma-separated layers when present)
353
477
  #
354
- # @return [String, nil]
355
- optional :box_shadow, String, api_name: :boxShadow
478
+ # @return [String]
479
+ required :box_shadow, String, api_name: :boxShadow
356
480
 
357
481
  # @!attribute color
358
482
  #
359
- # @return [String, nil]
360
- optional :color, String
483
+ # @return [String]
484
+ required :color, String
485
+
486
+ # @!attribute css
487
+ # Ready-to-use CSS declaration block for this component style
488
+ #
489
+ # @return [String]
490
+ required :css, String
361
491
 
362
492
  # @!attribute font_size
363
493
  #
364
- # @return [String, nil]
365
- optional :font_size, String, api_name: :fontSize
494
+ # @return [String]
495
+ required :font_size, String, api_name: :fontSize
366
496
 
367
497
  # @!attribute font_weight
368
498
  #
369
- # @return [Float, nil]
370
- optional :font_weight, Float, api_name: :fontWeight
499
+ # @return [Float]
500
+ required :font_weight, Float, api_name: :fontWeight
501
+
502
+ # @!attribute min_height
503
+ # Sampled minimum height of the button box (typically px)
504
+ #
505
+ # @return [String]
506
+ required :min_height, String, api_name: :minHeight
507
+
508
+ # @!attribute min_width
509
+ # Sampled minimum width of the button box (typically px)
510
+ #
511
+ # @return [String]
512
+ required :min_width, String, api_name: :minWidth
371
513
 
372
514
  # @!attribute padding
373
515
  #
374
- # @return [String, nil]
375
- optional :padding, String
516
+ # @return [String]
517
+ required :padding, String
376
518
 
377
519
  # @!attribute text_decoration
378
520
  #
521
+ # @return [String]
522
+ required :text_decoration, String, api_name: :textDecoration
523
+
524
+ # @!attribute font_fallbacks
525
+ # Full ordered font list from computed font-family
526
+ #
527
+ # @return [Array<String>, nil]
528
+ optional :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
529
+
530
+ # @!attribute font_family
531
+ # Primary button typeface (first in fontFallbacks)
532
+ #
379
533
  # @return [String, nil]
380
- optional :text_decoration, String, api_name: :textDecoration
534
+ optional :font_family, String, api_name: :fontFamily
381
535
 
382
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
383
- # Secondary button style
536
+ # @!attribute text_decoration_color
537
+ # Hex color of the underline when it differs from the text color
538
+ #
539
+ # @return [String, nil]
540
+ optional :text_decoration_color, String, api_name: :textDecorationColor
541
+
542
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
543
+ # Some parameter documentations has been truncated, see
544
+ # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary}
545
+ # for more details.
384
546
  #
385
547
  # @param background_color [String]
386
- # @param border_color [String]
548
+ #
549
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
550
+ #
387
551
  # @param border_radius [String]
552
+ #
388
553
  # @param border_style [String]
554
+ #
389
555
  # @param border_width [String]
390
- # @param box_shadow [String]
556
+ #
557
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
558
+ #
391
559
  # @param color [String]
560
+ #
561
+ # @param css [String] Ready-to-use CSS declaration block for this component style
562
+ #
392
563
  # @param font_size [String]
564
+ #
393
565
  # @param font_weight [Float]
566
+ #
567
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
568
+ #
569
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
570
+ #
394
571
  # @param padding [String]
572
+ #
395
573
  # @param text_decoration [String]
574
+ #
575
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
576
+ #
577
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
578
+ #
579
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
396
580
  end
397
581
  end
398
582
 
@@ -400,54 +584,75 @@ module ContextDev
400
584
  class Card < ContextDev::Internal::Type::BaseModel
401
585
  # @!attribute background_color
402
586
  #
403
- # @return [String, nil]
404
- optional :background_color, String, api_name: :backgroundColor
587
+ # @return [String]
588
+ required :background_color, String, api_name: :backgroundColor
405
589
 
406
590
  # @!attribute border_color
591
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
592
+ # alpha)
407
593
  #
408
- # @return [String, nil]
409
- optional :border_color, String, api_name: :borderColor
594
+ # @return [String]
595
+ required :border_color, String, api_name: :borderColor
410
596
 
411
597
  # @!attribute border_radius
412
598
  #
413
- # @return [String, nil]
414
- optional :border_radius, String, api_name: :borderRadius
599
+ # @return [String]
600
+ required :border_radius, String, api_name: :borderRadius
415
601
 
416
602
  # @!attribute border_style
417
603
  #
418
- # @return [String, nil]
419
- optional :border_style, String, api_name: :borderStyle
604
+ # @return [String]
605
+ required :border_style, String, api_name: :borderStyle
420
606
 
421
607
  # @!attribute border_width
422
608
  #
423
- # @return [String, nil]
424
- optional :border_width, String, api_name: :borderWidth
609
+ # @return [String]
610
+ required :border_width, String, api_name: :borderWidth
425
611
 
426
612
  # @!attribute box_shadow
427
613
  #
428
- # @return [String, nil]
429
- optional :box_shadow, String, api_name: :boxShadow
614
+ # @return [String]
615
+ required :box_shadow, String, api_name: :boxShadow
616
+
617
+ # @!attribute css
618
+ # Ready-to-use CSS declaration block for this component style
619
+ #
620
+ # @return [String]
621
+ required :css, String
430
622
 
431
623
  # @!attribute padding
432
624
  #
433
- # @return [String, nil]
434
- optional :padding, String
625
+ # @return [String]
626
+ required :padding, String
435
627
 
436
628
  # @!attribute text_color
437
629
  #
438
- # @return [String, nil]
439
- optional :text_color, String, api_name: :textColor
630
+ # @return [String]
631
+ required :text_color, String, api_name: :textColor
440
632
 
441
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, padding: nil, text_color: nil)
633
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, css:, padding:, text_color:)
634
+ # Some parameter documentations has been truncated, see
635
+ # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card}
636
+ # for more details.
637
+ #
442
638
  # Card component style
443
639
  #
444
640
  # @param background_color [String]
445
- # @param border_color [String]
641
+ #
642
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
643
+ #
446
644
  # @param border_radius [String]
645
+ #
447
646
  # @param border_style [String]
647
+ #
448
648
  # @param border_width [String]
649
+ #
449
650
  # @param box_shadow [String]
651
+ #
652
+ # @param css [String] Ready-to-use CSS declaration block for this component style
653
+ #
450
654
  # @param padding [String]
655
+ #
451
656
  # @param text_color [String]
452
657
  end
453
658
  end
@@ -455,47 +660,38 @@ module ContextDev
455
660
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#element_spacing
456
661
  class ElementSpacing < ContextDev::Internal::Type::BaseModel
457
662
  # @!attribute lg
458
- # Large spacing value
459
663
  #
460
- # @return [String, nil]
461
- optional :lg, String
664
+ # @return [String]
665
+ required :lg, String
462
666
 
463
667
  # @!attribute md
464
- # Medium spacing value
465
668
  #
466
- # @return [String, nil]
467
- optional :md, String
669
+ # @return [String]
670
+ required :md, String
468
671
 
469
672
  # @!attribute sm
470
- # Small spacing value
471
673
  #
472
- # @return [String, nil]
473
- optional :sm, String
674
+ # @return [String]
675
+ required :sm, String
474
676
 
475
677
  # @!attribute xl
476
- # Extra large spacing value
477
678
  #
478
- # @return [String, nil]
479
- optional :xl, String
679
+ # @return [String]
680
+ required :xl, String
480
681
 
481
682
  # @!attribute xs
482
- # Extra small spacing value
483
683
  #
484
- # @return [String, nil]
485
- optional :xs, String
684
+ # @return [String]
685
+ required :xs, String
486
686
 
487
- # @!method initialize(lg: nil, md: nil, sm: nil, xl: nil, xs: nil)
687
+ # @!method initialize(lg:, md:, sm:, xl:, xs:)
488
688
  # Spacing system used on the website
489
689
  #
490
- # @param lg [String] Large spacing value
491
- #
492
- # @param md [String] Medium spacing value
493
- #
494
- # @param sm [String] Small spacing value
495
- #
496
- # @param xl [String] Extra large spacing value
497
- #
498
- # @param xs [String] Extra small spacing value
690
+ # @param lg [String]
691
+ # @param md [String]
692
+ # @param sm [String]
693
+ # @param xl [String]
694
+ # @param xs [String]
499
695
  end
500
696
 
501
697
  # The primary color mode of the website design
@@ -514,47 +710,38 @@ module ContextDev
514
710
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#shadows
515
711
  class Shadows < ContextDev::Internal::Type::BaseModel
516
712
  # @!attribute inner
517
- # Inner shadow value
518
713
  #
519
- # @return [String, nil]
520
- optional :inner, String
714
+ # @return [String]
715
+ required :inner, String
521
716
 
522
717
  # @!attribute lg
523
- # Large shadow value
524
718
  #
525
- # @return [String, nil]
526
- optional :lg, String
719
+ # @return [String]
720
+ required :lg, String
527
721
 
528
722
  # @!attribute md
529
- # Medium shadow value
530
723
  #
531
- # @return [String, nil]
532
- optional :md, String
724
+ # @return [String]
725
+ required :md, String
533
726
 
534
727
  # @!attribute sm
535
- # Small shadow value
536
728
  #
537
- # @return [String, nil]
538
- optional :sm, String
729
+ # @return [String]
730
+ required :sm, String
539
731
 
540
732
  # @!attribute xl
541
- # Extra large shadow value
542
733
  #
543
- # @return [String, nil]
544
- optional :xl, String
734
+ # @return [String]
735
+ required :xl, String
545
736
 
546
- # @!method initialize(inner: nil, lg: nil, md: nil, sm: nil, xl: nil)
737
+ # @!method initialize(inner:, lg:, md:, sm:, xl:)
547
738
  # Shadow styles used on the website
548
739
  #
549
- # @param inner [String] Inner shadow value
550
- #
551
- # @param lg [String] Large shadow value
552
- #
553
- # @param md [String] Medium shadow value
554
- #
555
- # @param sm [String] Small shadow value
556
- #
557
- # @param xl [String] Extra large shadow value
740
+ # @param inner [String]
741
+ # @param lg [String]
742
+ # @param md [String]
743
+ # @param sm [String]
744
+ # @param xl [String]
558
745
  end
559
746
 
560
747
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#typography
@@ -562,24 +749,23 @@ module ContextDev
562
749
  # @!attribute headings
563
750
  # Heading styles
564
751
  #
565
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, nil]
566
- optional :headings,
752
+ # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings]
753
+ required :headings,
567
754
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings }
568
755
 
569
756
  # @!attribute p_
570
- # Paragraph text styles
571
757
  #
572
758
  # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P, nil]
573
759
  optional :p_,
574
760
  -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P },
575
761
  api_name: :p
576
762
 
577
- # @!method initialize(headings: nil, p_: nil)
763
+ # @!method initialize(headings:, p_: nil)
578
764
  # Typography styles used on the website
579
765
  #
580
766
  # @param headings [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings] Heading styles
581
767
  #
582
- # @param p_ [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P] Paragraph text styles
768
+ # @param p_ [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P]
583
769
 
584
770
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#headings
585
771
  class Headings < ContextDev::Internal::Type::BaseModel
@@ -617,179 +803,242 @@ module ContextDev
617
803
 
618
804
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h1
619
805
  class H1 < ContextDev::Internal::Type::BaseModel
806
+ # @!attribute font_fallbacks
807
+ # Full ordered font list from resolved computed font-family
808
+ #
809
+ # @return [Array<String>]
810
+ required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
811
+
620
812
  # @!attribute font_family
813
+ # Primary face (first family in the computed stack)
621
814
  #
622
- # @return [String, nil]
623
- optional :font_family, String, api_name: :fontFamily
815
+ # @return [String]
816
+ required :font_family, String, api_name: :fontFamily
624
817
 
625
818
  # @!attribute font_size
626
819
  #
627
- # @return [String, nil]
628
- optional :font_size, String, api_name: :fontSize
820
+ # @return [String]
821
+ required :font_size, String, api_name: :fontSize
629
822
 
630
823
  # @!attribute font_weight
631
824
  #
632
- # @return [Float, nil]
633
- optional :font_weight, Float, api_name: :fontWeight
825
+ # @return [Float]
826
+ required :font_weight, Float, api_name: :fontWeight
634
827
 
635
828
  # @!attribute letter_spacing
636
829
  #
637
- # @return [String, nil]
638
- optional :letter_spacing, String, api_name: :letterSpacing
830
+ # @return [String]
831
+ required :letter_spacing, String, api_name: :letterSpacing
639
832
 
640
833
  # @!attribute line_height
641
834
  #
642
- # @return [String, nil]
643
- optional :line_height, String, api_name: :lineHeight
835
+ # @return [String]
836
+ required :line_height, String, api_name: :lineHeight
644
837
 
645
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
646
- # @param font_family [String]
838
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
839
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
840
+ #
841
+ # @param font_family [String] Primary face (first family in the computed stack)
842
+ #
647
843
  # @param font_size [String]
844
+ #
648
845
  # @param font_weight [Float]
846
+ #
649
847
  # @param letter_spacing [String]
848
+ #
650
849
  # @param line_height [String]
651
850
  end
652
851
 
653
852
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h2
654
853
  class H2 < ContextDev::Internal::Type::BaseModel
854
+ # @!attribute font_fallbacks
855
+ # Full ordered font list from resolved computed font-family
856
+ #
857
+ # @return [Array<String>]
858
+ required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
859
+
655
860
  # @!attribute font_family
861
+ # Primary face (first family in the computed stack)
656
862
  #
657
- # @return [String, nil]
658
- optional :font_family, String, api_name: :fontFamily
863
+ # @return [String]
864
+ required :font_family, String, api_name: :fontFamily
659
865
 
660
866
  # @!attribute font_size
661
867
  #
662
- # @return [String, nil]
663
- optional :font_size, String, api_name: :fontSize
868
+ # @return [String]
869
+ required :font_size, String, api_name: :fontSize
664
870
 
665
871
  # @!attribute font_weight
666
872
  #
667
- # @return [Float, nil]
668
- optional :font_weight, Float, api_name: :fontWeight
873
+ # @return [Float]
874
+ required :font_weight, Float, api_name: :fontWeight
669
875
 
670
876
  # @!attribute letter_spacing
671
877
  #
672
- # @return [String, nil]
673
- optional :letter_spacing, String, api_name: :letterSpacing
878
+ # @return [String]
879
+ required :letter_spacing, String, api_name: :letterSpacing
674
880
 
675
881
  # @!attribute line_height
676
882
  #
677
- # @return [String, nil]
678
- optional :line_height, String, api_name: :lineHeight
883
+ # @return [String]
884
+ required :line_height, String, api_name: :lineHeight
679
885
 
680
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
681
- # @param font_family [String]
886
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
887
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
888
+ #
889
+ # @param font_family [String] Primary face (first family in the computed stack)
890
+ #
682
891
  # @param font_size [String]
892
+ #
683
893
  # @param font_weight [Float]
894
+ #
684
895
  # @param letter_spacing [String]
896
+ #
685
897
  # @param line_height [String]
686
898
  end
687
899
 
688
900
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h3
689
901
  class H3 < ContextDev::Internal::Type::BaseModel
902
+ # @!attribute font_fallbacks
903
+ # Full ordered font list from resolved computed font-family
904
+ #
905
+ # @return [Array<String>]
906
+ required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
907
+
690
908
  # @!attribute font_family
909
+ # Primary face (first family in the computed stack)
691
910
  #
692
- # @return [String, nil]
693
- optional :font_family, String, api_name: :fontFamily
911
+ # @return [String]
912
+ required :font_family, String, api_name: :fontFamily
694
913
 
695
914
  # @!attribute font_size
696
915
  #
697
- # @return [String, nil]
698
- optional :font_size, String, api_name: :fontSize
916
+ # @return [String]
917
+ required :font_size, String, api_name: :fontSize
699
918
 
700
919
  # @!attribute font_weight
701
920
  #
702
- # @return [Float, nil]
703
- optional :font_weight, Float, api_name: :fontWeight
921
+ # @return [Float]
922
+ required :font_weight, Float, api_name: :fontWeight
704
923
 
705
924
  # @!attribute letter_spacing
706
925
  #
707
- # @return [String, nil]
708
- optional :letter_spacing, String, api_name: :letterSpacing
926
+ # @return [String]
927
+ required :letter_spacing, String, api_name: :letterSpacing
709
928
 
710
929
  # @!attribute line_height
711
930
  #
712
- # @return [String, nil]
713
- optional :line_height, String, api_name: :lineHeight
931
+ # @return [String]
932
+ required :line_height, String, api_name: :lineHeight
714
933
 
715
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
716
- # @param font_family [String]
934
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
935
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
936
+ #
937
+ # @param font_family [String] Primary face (first family in the computed stack)
938
+ #
717
939
  # @param font_size [String]
940
+ #
718
941
  # @param font_weight [Float]
942
+ #
719
943
  # @param letter_spacing [String]
944
+ #
720
945
  # @param line_height [String]
721
946
  end
722
947
 
723
948
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h4
724
949
  class H4 < ContextDev::Internal::Type::BaseModel
950
+ # @!attribute font_fallbacks
951
+ # Full ordered font list from resolved computed font-family
952
+ #
953
+ # @return [Array<String>]
954
+ required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
955
+
725
956
  # @!attribute font_family
957
+ # Primary face (first family in the computed stack)
726
958
  #
727
- # @return [String, nil]
728
- optional :font_family, String, api_name: :fontFamily
959
+ # @return [String]
960
+ required :font_family, String, api_name: :fontFamily
729
961
 
730
962
  # @!attribute font_size
731
963
  #
732
- # @return [String, nil]
733
- optional :font_size, String, api_name: :fontSize
964
+ # @return [String]
965
+ required :font_size, String, api_name: :fontSize
734
966
 
735
967
  # @!attribute font_weight
736
968
  #
737
- # @return [Float, nil]
738
- optional :font_weight, Float, api_name: :fontWeight
969
+ # @return [Float]
970
+ required :font_weight, Float, api_name: :fontWeight
739
971
 
740
972
  # @!attribute letter_spacing
741
973
  #
742
- # @return [String, nil]
743
- optional :letter_spacing, String, api_name: :letterSpacing
974
+ # @return [String]
975
+ required :letter_spacing, String, api_name: :letterSpacing
744
976
 
745
977
  # @!attribute line_height
746
978
  #
747
- # @return [String, nil]
748
- optional :line_height, String, api_name: :lineHeight
979
+ # @return [String]
980
+ required :line_height, String, api_name: :lineHeight
749
981
 
750
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
751
- # @param font_family [String]
982
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
983
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
984
+ #
985
+ # @param font_family [String] Primary face (first family in the computed stack)
986
+ #
752
987
  # @param font_size [String]
988
+ #
753
989
  # @param font_weight [Float]
990
+ #
754
991
  # @param letter_spacing [String]
992
+ #
755
993
  # @param line_height [String]
756
994
  end
757
995
  end
758
996
 
759
997
  # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#p_
760
998
  class P < ContextDev::Internal::Type::BaseModel
999
+ # @!attribute font_fallbacks
1000
+ # Full ordered font list from resolved computed font-family
1001
+ #
1002
+ # @return [Array<String>]
1003
+ required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
1004
+
761
1005
  # @!attribute font_family
1006
+ # Primary face (first family in the computed stack)
762
1007
  #
763
- # @return [String, nil]
764
- optional :font_family, String, api_name: :fontFamily
1008
+ # @return [String]
1009
+ required :font_family, String, api_name: :fontFamily
765
1010
 
766
1011
  # @!attribute font_size
767
1012
  #
768
- # @return [String, nil]
769
- optional :font_size, String, api_name: :fontSize
1013
+ # @return [String]
1014
+ required :font_size, String, api_name: :fontSize
770
1015
 
771
1016
  # @!attribute font_weight
772
1017
  #
773
- # @return [Float, nil]
774
- optional :font_weight, Float, api_name: :fontWeight
1018
+ # @return [Float]
1019
+ required :font_weight, Float, api_name: :fontWeight
775
1020
 
776
1021
  # @!attribute letter_spacing
777
1022
  #
778
- # @return [String, nil]
779
- optional :letter_spacing, String, api_name: :letterSpacing
1023
+ # @return [String]
1024
+ required :letter_spacing, String, api_name: :letterSpacing
780
1025
 
781
1026
  # @!attribute line_height
782
1027
  #
783
- # @return [String, nil]
784
- optional :line_height, String, api_name: :lineHeight
1028
+ # @return [String]
1029
+ required :line_height, String, api_name: :lineHeight
785
1030
 
786
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
787
- # Paragraph text styles
1031
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
1032
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
1033
+ #
1034
+ # @param font_family [String] Primary face (first family in the computed stack)
788
1035
  #
789
- # @param font_family [String]
790
1036
  # @param font_size [String]
1037
+ #
791
1038
  # @param font_weight [Float]
1039
+ #
792
1040
  # @param letter_spacing [String]
1041
+ #
793
1042
  # @param line_height [String]
794
1043
  end
795
1044
  end