ariadne_view_components 0.0.93.1 → 0.0.94

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/README.md +13 -4
  4. data/app/assets/javascripts/ariadne_view_components.js +14 -14
  5. data/app/assets/javascripts/ariadne_view_components.js.br +0 -0
  6. data/app/assets/javascripts/ariadne_view_components.js.gz +0 -0
  7. data/app/assets/javascripts/ariadne_view_components.js.map +1 -1
  8. data/app/assets/stylesheets/ariadne_view_components.css +1 -1
  9. data/app/assets/stylesheets/ariadne_view_components.css.br +0 -0
  10. data/app/assets/stylesheets/ariadne_view_components.css.gz +0 -0
  11. data/app/components/ariadne/base_component.rb +25 -22
  12. data/app/components/ariadne/behaviors/tooltipable.rb +12 -12
  13. data/app/components/ariadne/form/checkbox/component.rb +2 -2
  14. data/app/components/ariadne/form/group/component.rb +1 -1
  15. data/app/components/ariadne/form/radio_button/component.rb +2 -2
  16. data/app/components/ariadne/form/select/component.rb +1 -1
  17. data/app/components/ariadne/form/text_field/component.html.erb +2 -2
  18. data/app/components/ariadne/form/text_field/component.rb +14 -7
  19. data/app/components/ariadne/form/toggle/component.rb +2 -2
  20. data/app/components/ariadne/form/toggle_group/component.rb +1 -1
  21. data/app/components/ariadne/form/toggle_group/option/component.rb +1 -1
  22. data/app/components/ariadne/layout/grid/component.rb +1 -1
  23. data/app/components/ariadne/layout/grid/item/component.rb +2 -2
  24. data/app/components/ariadne/layout/label_block/component.rb +1 -1
  25. data/app/components/ariadne/layout/narrow/component.rb +1 -1
  26. data/app/components/ariadne/ui/accordion/component.rb +3 -1
  27. data/app/components/ariadne/ui/accordion/item/component.html.erb +10 -10
  28. data/app/components/ariadne/ui/accordion/item/component.rb +12 -3
  29. data/app/components/ariadne/ui/avatar/component.html.erb +9 -7
  30. data/app/components/ariadne/ui/avatar/component.rb +55 -7
  31. data/app/components/ariadne/ui/badge/component.rb +35 -16
  32. data/app/components/ariadne/ui/banner/component.html.erb +23 -0
  33. data/app/components/ariadne/ui/banner/component.rb +226 -0
  34. data/app/components/ariadne/ui/banner/component.ts +46 -0
  35. data/app/components/ariadne/ui/blankslate/component.html.erb +2 -2
  36. data/app/components/ariadne/ui/blankslate/component.rb +12 -1
  37. data/app/components/ariadne/ui/button/component.rb +35 -24
  38. data/app/components/ariadne/ui/card/body/component.rb +1 -1
  39. data/app/components/ariadne/ui/card/component.rb +11 -7
  40. data/app/components/ariadne/ui/card/footer/component.rb +1 -1
  41. data/app/components/ariadne/ui/card/header/component.html.erb +2 -2
  42. data/app/components/ariadne/ui/card/header/component.rb +25 -16
  43. data/app/components/ariadne/ui/clipboard_copy/component.html.erb +1 -0
  44. data/app/components/ariadne/ui/clipboard_copy/component.rb +17 -21
  45. data/app/components/ariadne/ui/clipboard_copy/component.ts +15 -0
  46. data/app/components/ariadne/ui/color_dot/component.html.erb +5 -5
  47. data/app/components/ariadne/ui/color_dot/component.rb +19 -4
  48. data/app/components/ariadne/ui/combobox/component.html.erb +1 -1
  49. data/app/components/ariadne/ui/combobox/component.rb +54 -23
  50. data/app/components/ariadne/ui/combobox/component.ts +2 -0
  51. data/app/components/ariadne/ui/dialog/body/component.html.erb +3 -0
  52. data/app/components/ariadne/ui/dialog/body/component.rb +28 -0
  53. data/app/components/ariadne/ui/dialog/component.html.erb +25 -24
  54. data/app/components/ariadne/ui/dialog/component.rb +87 -18
  55. data/app/components/ariadne/ui/dialog/component.ts +5 -1
  56. data/app/components/ariadne/ui/dialog/footer/component.html.erb +3 -0
  57. data/app/components/ariadne/ui/dialog/footer/component.rb +34 -0
  58. data/app/components/ariadne/ui/heroicon/component.rb +21 -21
  59. data/app/components/ariadne/ui/image/component.rb +11 -23
  60. data/app/components/ariadne/ui/link/component.html.erb +1 -3
  61. data/app/components/ariadne/ui/link/component.rb +17 -4
  62. data/app/components/ariadne/ui/list/component.html.erb +5 -9
  63. data/app/components/ariadne/ui/list/component.rb +31 -7
  64. data/app/components/ariadne/ui/list/item/component.rb +6 -5
  65. data/app/components/ariadne/ui/pagination/component.rb +1 -2
  66. data/app/components/ariadne/ui/popover/component.html.erb +1 -1
  67. data/app/components/ariadne/ui/popover/component.rb +31 -26
  68. data/app/components/ariadne/ui/relative_time/component.html.erb +1 -0
  69. data/app/components/ariadne/ui/{time_ago → relative_time}/component.rb +15 -15
  70. data/app/components/ariadne/ui/{time_ago → relative_time}/component.ts +1 -1
  71. data/app/components/ariadne/ui/shortcut/component.html.erb +0 -1
  72. data/app/components/ariadne/ui/shortcut/component.rb +31 -5
  73. data/app/components/ariadne/ui/shortcut/component.ts +1 -1
  74. data/app/components/ariadne/ui/skeleton/component.rb +2 -8
  75. data/app/components/ariadne/ui/stats_panel/component.html.erb +3 -3
  76. data/app/components/ariadne/ui/stats_panel/component.rb +25 -1
  77. data/app/components/ariadne/ui/stats_panel/item/component.html.erb +3 -3
  78. data/app/components/ariadne/ui/stats_panel/item/component.rb +6 -6
  79. data/app/components/ariadne/ui/table/cell/component.rb +1 -1
  80. data/app/components/ariadne/ui/table/row/component.rb +1 -1
  81. data/app/components/ariadne/ui/typography/component.rb +3 -1
  82. data/app/frontend/controllers/tooltip_controller.ts +8 -3
  83. data/app/frontend/stylesheets/ariadne_view_components.css +1 -0
  84. data/app/frontend/stylesheets/theme.css +88 -0
  85. data/app/frontend/utils/createController.ts +9 -0
  86. data/app/helpers/ariadne/color_helper.rb +158 -0
  87. data/app/helpers/ariadne/form_helper.rb +1 -0
  88. data/app/helpers/ariadne/size_helper.rb +7 -0
  89. data/app/lib/ariadne/attributes_helper.rb +4 -4
  90. data/app/lib/ariadne/view_component/style_variants.rb +1 -1
  91. data/app/lib/ariadne/view_helper.rb +0 -6
  92. data/lib/ariadne/accessibility.rb +64 -0
  93. data/lib/ariadne/forms/dsl/form_object.rb +5 -1
  94. data/lib/ariadne/forms/dsl/input.rb +1 -1
  95. data/lib/ariadne/static/generate_arguments.rb +54 -0
  96. data/lib/ariadne/static/generate_audited_at.rb +17 -0
  97. data/lib/ariadne/static/generate_constants.rb +19 -0
  98. data/lib/ariadne/static/generate_previews.rb +53 -0
  99. data/lib/ariadne/static/generate_statuses.rb +17 -0
  100. data/lib/ariadne/static/generate_structure.rb +279 -0
  101. data/lib/ariadne/static.rb +68 -0
  102. data/lib/ariadne/view_components/constants.rb +2 -2
  103. data/lib/ariadne/view_components/version.rb +1 -1
  104. data/lib/ariadne/view_components.rb +0 -51
  105. data/lib/ariadne/yard/component_manifest.rb +81 -81
  106. data/lib/ariadne/yard/component_ref.rb +1 -1
  107. data/lib/ariadne/yard/docs_helper.rb +24 -16
  108. data/lib/ariadne/yard/dry_initializer/common_handler.rb +103 -0
  109. data/lib/ariadne/yard/dry_initializer/option_handler.rb +38 -0
  110. data/lib/ariadne/yard/dry_initializer/param_handler.rb +57 -0
  111. data/lib/ariadne/yard/registry.rb +2 -5
  112. data/lib/ariadne/yard/{info_arch_docs_helper.rb → structure_docs_helper.rb} +5 -5
  113. data/lib/ariadne/yard.rb +20 -8
  114. data/lib/rubocop/config/default.yml +0 -3
  115. metadata +34 -37
  116. data/app/components/ariadne/behaviors/captionable.rb +0 -55
  117. data/app/components/ariadne/turbo/frame/component.html.erb +0 -3
  118. data/app/components/ariadne/turbo/frame/component.rb +0 -16
  119. data/app/components/ariadne/turbo/stream_action/component.html.erb +0 -4
  120. data/app/components/ariadne/turbo/stream_action/component.rb +0 -25
  121. data/app/components/ariadne/ui/data_table/component.html.erb +0 -1
  122. data/app/components/ariadne/ui/data_table/component.rb +0 -11
  123. data/app/components/ariadne/ui/flash/component.html.erb +0 -18
  124. data/app/components/ariadne/ui/flash/component.rb +0 -151
  125. data/app/components/ariadne/ui/flash/component.ts +0 -56
  126. data/app/components/ariadne/ui/overlay/component.html.erb +0 -12
  127. data/app/components/ariadne/ui/overlay/component.rb +0 -54
  128. data/app/components/ariadne/ui/overlay/component.ts +0 -92
  129. data/app/components/ariadne/ui/time_ago/component.html.erb +0 -1
  130. data/lib/ariadne/view_components/commands.rb +0 -90
  131. data/lib/ariadne/view_components/statuses.rb +0 -14
  132. data/lib/ariadne/view_components/upstream.rb +0 -19
  133. data/lib/ariadne/yard/lookbook_pages_backend.rb +0 -235
  134. data/lib/rubocop/cop/ariadne/no_tag_memoize.rb +0 -44
  135. data/static/arguments.yml +0 -879
  136. data/static/assets/view-components.svg +0 -18
  137. data/static/classes.yml +0 -211
  138. data/static/constants.json +0 -743
  139. data/static/statuses.json +0 -58
  140. data/static/tailwindcss.yml +0 -727
  141. /data/app/components/ariadne/ui/{time_ago → relative_time}/en.yml +0 -0
data/static/arguments.yml DELETED
@@ -1,879 +0,0 @@
1
- ---
2
- - component: AvatarComponent
3
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/avatar_component.rb
4
- parameters:
5
- - name: src
6
- type: String
7
- default: N/A
8
- description: The source url of the avatar image.
9
- - name: alt
10
- type: String
11
- default: N/A
12
- description: Passed through to alt on img tag.
13
- - name: size
14
- type: Integer
15
- default: "`20`"
16
- description: One of `16`, `20`, `24`, `32`, `40`, `48`, or `80`.
17
- - name: shape
18
- type: Symbol
19
- default: "`:circle`"
20
- description: Shape of the avatar. One of `:circle` and `:square`.
21
- - name: href
22
- type: String
23
- default: "`nil`"
24
- description: The URL to link to. If used, component will be wrapped by an `<a>`
25
- tag.
26
- - name: classes
27
- type: String
28
- default: '`""`'
29
- description: "[Classes and attributes](/classes-attributes)"
30
- - name: attributes
31
- type: Hash
32
- default: "`{}`"
33
- description: "[Classes and attributes](/classes-attributes)"
34
- - component: AvatarStackComponent
35
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/avatar_stack_component.rb
36
- parameters:
37
- - name: tag
38
- type: Symbol
39
- default: "`:div`"
40
- description: One of `:div` and `:span`.
41
- - name: align
42
- type: Symbol
43
- default: "`:left`"
44
- description: One of `:left` and `:right`.
45
- - name: classes
46
- type: String
47
- default: '`""`'
48
- description: "[Classes and attributes](/classes-attributes)"
49
- - name: attributes
50
- type: Hash
51
- default: "`{}`"
52
- description: "[Classes and attributes](/classes-attributes)"
53
- - component: BaseButton
54
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/base_button.rb
55
- parameters:
56
- - name: tag
57
- type: Symbol
58
- default: "`:button`"
59
- description: One of `:a`, `:button`, or `:summary`.
60
- - name: type
61
- type: Symbol
62
- default: "`:button`"
63
- description: One of `:button`, `:reset`, or `:submit`.
64
- - name: size
65
- type: Symbol
66
- default: "`:md`"
67
- description: One of `:lg`, `:md`, `:sm`, `:xl`, or `:xs`.
68
- - name: classes
69
- type: String
70
- default: '`""`'
71
- description: "[Classes and attributes](/classes-attributes)"
72
- - name: attributes
73
- type: Hash
74
- default: "`{}`"
75
- description: "[Classes and attributes](/classes-attributes)"
76
- - component: BlankslateComponent
77
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/blankslate_component.rb
78
- parameters:
79
- - name: tag
80
- type: Symbol, String
81
- default: "`:div`"
82
- description: The rendered tag name
83
- - name: classes
84
- type: String
85
- default: '`""`'
86
- description: "[Classes and attributes](/classes-attributes)"
87
- - name: attributes
88
- type: Hash
89
- default: "`{}`"
90
- description: "[Classes and attributes](/classes-attributes)"
91
- - component: BodyComponent
92
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/body_component.rb
93
- parameters:
94
- - name: classes
95
- type: String
96
- default: '`""`'
97
- description: "[Classes and attributes](/classes-attributes)"
98
- - name: attributes
99
- type: Hash
100
- default: "`{}`"
101
- description: "[Classes and attributes](/classes-attributes)"
102
- - component: BreadcrumbsComponent
103
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/breadcrumbs_component.rb
104
- parameters:
105
- - name: tag
106
- type: Symbol, String
107
- default: "`:nav`"
108
- description: The rendered tag name.
109
- - name: items
110
- type: Array<Hash>
111
- default: "`[]`"
112
- description: The items to display in the breadcrumb.
113
- - name: classes
114
- type: String
115
- default: '`""`'
116
- description: "[Classes and attributes](/classes-attributes)"
117
- - name: item_classes
118
- type: String
119
- default: '`""`'
120
- description: List of additional classes to apply to each item.
121
- - name: active_item_classes
122
- type: String
123
- default: '`""`'
124
- description: List of additional classes to apply to the active item.
125
- - name: attributes
126
- type: Hash
127
- default: "`{}`"
128
- description: "[Classes and attributes](/classes-attributes)"
129
- - component: ButtonComponent
130
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/button_component.rb
131
- parameters:
132
- - name: tag
133
- type: Symbol
134
- default: "`:button`"
135
- description: One of `:a`, `:button`, or `:summary`.
136
- - name: type
137
- type: Symbol
138
- default: "`:button`"
139
- description: One of `:button`, `:reset`, or `:submit`.
140
- - name: scheme
141
- type: Symbol
142
- default: "`:default`"
143
- description: One of `:danger`, `:default`, `:info`, `:link`, `:none`, `:success`,
144
- or `:warning`.
145
- - name: size
146
- type: Symbol
147
- default: "`BaseButton::DEFAULT_SIZE`"
148
- description: One of `:lg`, `:md`, `:sm`, `:xl`, or `:xs`.
149
- - name: dropdown
150
- type: Boolean
151
- default: "`false`"
152
- description: Whether or not to render a dropdown caret.
153
- - name: classes
154
- type: String
155
- default: '`""`'
156
- description: "[Classes and attributes](/classes-attributes)"
157
- - name: attributes
158
- type: Hash
159
- default: "`{}`"
160
- description: "[Classes and attributes](/classes-attributes)"
161
- - component: CheckboxComponent
162
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/checkbox_component.rb
163
- parameters:
164
- - name: tag
165
- type: Symbol, String
166
- default: "`:label`"
167
- description: The rendered tag name.
168
- - name: classes
169
- type: String
170
- default: '`""`'
171
- description: "[Classes and attributes](/classes-attributes)"
172
- - name: input_classes
173
- type: String
174
- default: '`""`'
175
- description: List of additional classes to apply to the input.
176
- - name: initial_value
177
- type: Boolean
178
- default: "`false`"
179
- description: The initial value of the checkbox.
180
- - name: attributes
181
- type: Hash
182
- default: "`{}`"
183
- description: "[Classes and attributes](/classes-attributes)"
184
- - name: input_attributes
185
- type: Hash
186
- default: "`{}`"
187
- description: "[Classes and attributes](/classes-attributes)"
188
- - component: ClipboardCopyComponent
189
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/clipboard_copy_component.rb
190
- parameters:
191
- - name: tag
192
- type: Symbol, String
193
- default: "`:clipboard-copy`"
194
- description: The rendered tag name
195
- - name: classes
196
- type: String
197
- default: '`""`'
198
- description: "[Classes and attributes](/classes-attributes)"
199
- - name: value
200
- type: String
201
- default: '`""`'
202
- description: Text to copy into the users clipboard when they click the component.
203
- - name: for_id
204
- type: String
205
- default: "`nil`"
206
- description: If `value` is not provided, the element with this id will be copied.
207
- - name: aria_label
208
- type: String
209
- default: '`""`'
210
- description: Text for accessibility. Can also be passed in as part of `attributes`,
211
- but it must be present.
212
- - name: attributes
213
- type: Hash
214
- default: "`{}`"
215
- description: "[Classes and attributes](/classes-attributes)"
216
- - component: CloseButtonComponent
217
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/close_button_component.rb
218
- parameters:
219
- - name: tag
220
- type: Symbol, String
221
- default: "`:button`"
222
- description: The rendered tag name.
223
- - name: classes
224
- type: String
225
- default: '`""`'
226
- description: "[Classes and attributes](/classes-attributes)"
227
- - name: icon_classes
228
- type: String
229
- default: '`""`'
230
- description: Classes to apply to the icon.
231
- - name: size
232
- type: Symbol
233
- default: "`:xs`"
234
- description: One of `:xs` (`16`), `:sm` (`20`), `:md` (`24`), or `:lg` (`128`).
235
- - name: aria_label
236
- type: String
237
- default: "`nil`"
238
- description: A label for the button that describes what it will close.
239
- - name: scheme
240
- type: Symbol
241
- default: "`:none`"
242
- description: One of `:link` (`ariadne-cursor-pointer ariadne-font-semibold ariadne-underline
243
- ariadne-decoration-double`), `:none` (``), `:default` (`ariadne-text-slate-800
244
- ariadne-bg-slate-50 hover:ariadne-bg-slate-100 ariadne-border-slate-300 focus:ariadne-ring-offset-slate-50
245
- focus:ariadne-ring-slate-600`), `:info` (`ariadne-text-slate-800 ariadne-bg-slate-50
246
- hover:ariadne-bg-slate-100 ariadne-border-slate-300 focus:ariadne-ring-offset-blue-50
247
- focus:ariadne-ring-slate-600`), `:success` (`ariadne-text-green-800 ariadne-bg-green-50
248
- hover:ariadne-bg-green-100 ariadne-border-green-300 focus:ariadne-ring-offset-green-50
249
- focus:ariadne-ring-green-600`), `:warning` (`ariadne-text-yellow-800 ariadne-bg-yellow-50
250
- hover:ariadne-bg-yellow-100 ariadne-border-yellow-300 focus:ariadne-ring-offset-yellow-50
251
- focus:ariadne-ring-yellow-600`), or `:danger` (`ariadne-text-red-800 ariadne-bg-red-50
252
- hover:ariadne-bg-red-100 ariadne-border-red-300 focus:ariadne-ring-offset-red-50
253
- focus:ariadne-ring-red-600`).
254
- - name: attributes
255
- type: Hash
256
- default: "`{}`"
257
- description: "[Classes and attributes](/classes-attributes)"
258
- - component: ContainerComponent
259
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/container_component.rb
260
- parameters:
261
- - name: classes
262
- type: String
263
- default: '`""`'
264
- description: "[Classes and attributes](/classes-attributes)"
265
- - name: attributes
266
- type: Hash
267
- default: "`{}`"
268
- description: "[Classes and attributes](/classes-attributes)"
269
- - component: CounterComponent
270
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/counter_component.rb
271
- parameters:
272
- - name: tag
273
- type: Symbol, String
274
- default: "`:span`"
275
- description: The rendered tag name
276
- - name: classes
277
- type: String
278
- default: '`""`'
279
- description: "[Classes and attributes](/classes-attributes)"
280
- - name: count
281
- type: Integer, Float::INFINITY, nil
282
- default: "`0`"
283
- description: 'The number to be displayed (e.x. # of issues, pull requests)'
284
- - name: limit
285
- type: Integer, nil
286
- default: "`9_000`"
287
- description: Maximum value to display. Pass `nil` for no limit. (e.x. if `count`
288
- == 6,000 and `limit` == 5000, counter will display "5,000+")
289
- - name: hide_if_zero
290
- type: Boolean
291
- default: "`false`"
292
- description: If true, a `hidden` attribute is added to the counter if `count`
293
- is zero.
294
- - name: text
295
- type: String
296
- default: '`""`'
297
- description: Text to display instead of count.
298
- - name: round
299
- type: Boolean
300
- default: "`false`"
301
- description: Whether to apply rounding logic to value.
302
- - name: attributes
303
- type: Hash
304
- default: "`{}`"
305
- description: "[Classes and attributes](/classes-attributes)"
306
- - component: DetailsComponent
307
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/details_component.rb
308
- parameters:
309
- - name: overlay
310
- type: Symbol
311
- default: "`:none`"
312
- description: Dictates the type of overlay to render with. One of `:dark`, `:default`,
313
- or `:none`.
314
- - name: reset
315
- type: Boolean
316
- default: "`true`"
317
- description: If set to true, it will remove the default caret and remove style
318
- from the summary element
319
- - name: disabled
320
- type: Boolean
321
- default: "`false`"
322
- description: Whether or not to disable the summary button.
323
- - name: classes
324
- type: String
325
- default: '`""`'
326
- description: "[Classes and attributes](/classes-attributes)"
327
- - name: attributes
328
- type: Hash
329
- default: "`{}`"
330
- description: "[Classes and attributes](/classes-attributes)"
331
- - component: DropdownComponent
332
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/dropdown_component.rb
333
- parameters:
334
- - name: overlay
335
- type: Symbol
336
- default: "`:default`"
337
- description: One of `:dark`, `:default`, or `:none`.
338
- - name: with_caret
339
- type: Boolean
340
- default: "`false`"
341
- description: Whether or not a caret should be rendered in the button.
342
- - name: classes
343
- type: String
344
- default: '`""`'
345
- description: "[Classes and attributes](/classes-attributes)"
346
- - name: attributes
347
- type: Hash
348
- default: "`{}`"
349
- description: "[Classes and attributes](/classes-attributes)"
350
- - component: FlashComponent
351
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/flash_component.rb
352
- parameters:
353
- - name: tag
354
- type: Symbol, String
355
- default: "`:div`"
356
- description: The rendered tag name.
357
- - name: dismissible
358
- type: Boolean
359
- default: "`false`"
360
- description: Whether the component can be dismissed with an X button.
361
- - name: icon
362
- type: Symbol, String
363
- default: N/A
364
- description: Name of [Heroicon](https://ariadne.style/heroicons/) to use.
365
- - name: scheme
366
- type: Symbol
367
- default: "`:default`"
368
- description: One of `:danger`, `:default`, `:info`, `:success`, or `:warning`.
369
- - name: classes
370
- type: String
371
- default: '`""`'
372
- description: "[Classes and attributes](/classes-attributes)"
373
- - name: attributes
374
- type: Hash
375
- default: "`{}`"
376
- description: "[Classes and attributes](/classes-attributes)"
377
- - component: FlexComponent
378
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/flex_component.rb
379
- parameters:
380
- - name: tag
381
- type: Symbol, String
382
- default: "`:div`"
383
- description: The rendered tag name.
384
- - name: type
385
- type: Symbol
386
- default: N/A
387
- description: One of `:column`, `:column_reverse`, `:row`, or `:row_reverse`.
388
- - name: classes
389
- type: String
390
- default: '`""`'
391
- description: "[Classes and attributes](/classes-attributes)"
392
- - name: attributes
393
- type: Hash
394
- default: "`{}`"
395
- description: "[Classes and attributes](/classes-attributes)"
396
- - component: FooterComponent
397
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/footer_component.rb
398
- parameters:
399
- - name: classes
400
- type: String
401
- default: '`""`'
402
- description: "[Classes and attributes](/classes-attributes)"
403
- - name: attributes
404
- type: Hash
405
- default: "`{}`"
406
- description: "[Classes and attributes](/classes-attributes)"
407
- - component: GridComponent
408
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/grid_component.rb
409
- parameters:
410
- - name: classes
411
- type: String
412
- default: '`""`'
413
- description: "[Classes and attributes](/classes-attributes)"
414
- - name: attributes
415
- type: Hash
416
- default: "`{}`"
417
- description: "[Classes and attributes](/classes-attributes)"
418
- - component: HeaderComponent
419
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/header_component.rb
420
- parameters:
421
- - name: classes
422
- type: String
423
- default: '`""`'
424
- description: "[Classes and attributes](/classes-attributes)"
425
- - name: attributes
426
- type: Hash
427
- default: "`{}`"
428
- description: "[Classes and attributes](/classes-attributes)"
429
- - component: HeadingComponent
430
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/heading_component.rb
431
- parameters:
432
- - name: tag
433
- type: String
434
- default: "`nil`"
435
- description: One of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, or `:h6`.
436
- - name: classes
437
- type: String
438
- default: '`""`'
439
- description: "[Classes and attributes](/classes-attributes)"
440
- - name: attributes
441
- type: Hash
442
- default: "`{}`"
443
- description: "[Classes and attributes](/classes-attributes)"
444
- - component: HeroiconComponent
445
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/heroicon_component.rb
446
- parameters:
447
- - name: tag
448
- type: Symbol, String
449
- default: "`:svg`"
450
- description: The rendered tag name
451
- - name: classes
452
- type: String
453
- default: '`""`'
454
- description: "[Classes and attributes](/classes-attributes)"
455
- - name: icon
456
- type: Symbol, String
457
- default: N/A
458
- description: Name of [Heroicon](https://ariadne.style/heroicons/) to use.
459
- - name: variant
460
- type: String
461
- default: N/A
462
- description: One of `outline`, `solid`, or `mini`.
463
- - name: size
464
- type: Symbol
465
- default: "`:md`"
466
- description: One of `:xs` (`16`), `:sm` (`20`), `:md` (`24`), or `:lg` (`128`).
467
- - name: attributes
468
- type: Hash
469
- default: "`{}`"
470
- description: "[Classes and attributes](/classes-attributes)"
471
- - name: text_classes
472
- type: String
473
- default: '`""`'
474
- description: "[Classes and attributes](/classes-attributes)"
475
- - name: text_attributes
476
- type: Hash
477
- default: "`{}`"
478
- description: "[Classes and attributes](/classes-attributes)"
479
- - component: ImageComponent
480
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/image_component.rb
481
- parameters:
482
- - name: tag
483
- type: Symbol, String
484
- default: "`:img`"
485
- description: The rendered tag name
486
- - name: src
487
- type: String
488
- default: N/A
489
- description: The source url of the image.
490
- - name: alt
491
- type: String
492
- default: N/A
493
- description: Specifies an alternate text for the image.
494
- - name: lazy
495
- type: Boolean
496
- default: "`false`"
497
- description: Whether or not to lazily load the image.
498
- - name: classes
499
- type: String
500
- default: '`""`'
501
- description: "[Classes and attributes](/classes-attributes)"
502
- - name: attributes
503
- type: Hash
504
- default: "`{}`"
505
- description: "[Classes and attributes](/classes-attributes)"
506
- - component: InlineFlexComponent
507
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/inline_flex_component.rb
508
- parameters:
509
- - name: tag
510
- type: Symbol, String
511
- default: "`:span`"
512
- description: The rendered tag name
513
- - name: classes
514
- type: String
515
- default: '`""`'
516
- description: "[Classes and attributes](/classes-attributes)"
517
- - name: attributes
518
- type: Hash
519
- default: "`{}`"
520
- description: "[Classes and attributes](/classes-attributes)"
521
- - component: LinkComponent
522
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/link_component.rb
523
- parameters:
524
- - name: tag
525
- type: String
526
- default: "`:a`"
527
- description: One of `:a` and `:span`.
528
- - name: href
529
- type: String
530
- default: N/A
531
- description: URL to be used for the link.
532
- - name: actionable
533
- type: Boolean
534
- default: "`false`"
535
- description: If true, adds additional classes to the link to make it more aware.
536
- - name: classes
537
- type: String
538
- default: '`""`'
539
- description: "[Classes and attributes](/classes-attributes)"
540
- - name: attributes
541
- type: Hash
542
- default: "`{}`"
543
- description: "[Classes and attributes](/classes-attributes)"
544
- - component: ListComponent
545
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/list_component.rb
546
- parameters:
547
- - name: classes
548
- type: String
549
- default: '`""`'
550
- description: "[Classes and attributes](/classes-attributes)"
551
- - name: attributes
552
- type: Hash
553
- default: "`{}`"
554
- description: "[Classes and attributes](/classes-attributes)"
555
- - component: NarrowContainerComponent
556
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/narrow_container_component.rb
557
- parameters:
558
- - name: classes
559
- type: String
560
- default: '`""`'
561
- description: "[Classes and attributes](/classes-attributes)"
562
- - name: attributes
563
- type: Hash
564
- default: "`{}`"
565
- description: "[Classes and attributes](/classes-attributes)"
566
- - component: PanelBarComponent
567
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/panel_bar_component.rb
568
- parameters:
569
- - name: tag
570
- type: Symbol, String
571
- default: N/A
572
- description: The rendered tag name.
573
- - name: classes
574
- type: String
575
- default: '`""`'
576
- description: "[Classes and attributes](/classes-attributes)"
577
- - name: attributes
578
- type: Hash
579
- default: "`{}`"
580
- description: "[Classes and attributes](/classes-attributes)"
581
- - component: PillComponent
582
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/pill_component.rb
583
- parameters:
584
- - name: tag
585
- type: Symbol, String
586
- default: "`:span`"
587
- description: The rendered tag name.
588
- - name: color
589
- type: String
590
- default: N/A
591
- description: The rgba color of the pill.
592
- - name: classes
593
- type: String
594
- default: '`""`'
595
- description: "[Classes and attributes](/classes-attributes)"
596
- - name: attributes
597
- type: Hash
598
- default: "`{}`"
599
- description: "[Classes and attributes](/classes-attributes)"
600
- - component: ProgressBarComponent
601
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/progress_bar_component.rb
602
- parameters:
603
- - name: tag
604
- type: Symbol, String
605
- default: "`DEFAULT_TAGS[:wrapper]`"
606
- description: The rendered tag name.
607
- - name: min
608
- type: Integer
609
- default: "`0`"
610
- description: The minimum value of the progress bar.
611
- - name: max
612
- type: Integer
613
- default: "`100`"
614
- description: The maximum value of the progress bar.
615
- - name: size
616
- type: Symbol
617
- default: "`:md`"
618
- description: One of `:sm` (`ariadne-h-2`), `:md` (`ariadne-h-3`), or `:lg` (`ariadne-h-4`).
619
- - name: classes
620
- type: String
621
- default: '`""`'
622
- description: "[Classes and attributes](/classes-attributes)"
623
- - name: attributes
624
- type: Hash
625
- default: "`{}`"
626
- description: "[Classes and attributes](/classes-attributes)"
627
- - component: RelativeTimeComponent
628
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/relative_time_component.rb
629
- parameters:
630
- - name: tag
631
- type: Symbol, String
632
- default: "`:span`"
633
- description: The rendered tag name.
634
- - name: classes
635
- type: String
636
- default: '`""`'
637
- description: "[Classes and attributes](/classes-attributes)"
638
- - name: time
639
- type: Time
640
- default: "`nil`"
641
- description: The time to display.
642
- - name: format
643
- type: String
644
- default: "`%b %-d, %Y`"
645
- description: The format to display the time in.
646
- - name: date_format_switch
647
- type: Integer
648
- default: "`2592000`"
649
- description: The number of seconds after which to switch to the date format.
650
- - name: force_relative
651
- type: Boolean
652
- default: "`false`"
653
- description: Force the time to be displayed in relative format.
654
- - name: attributes
655
- type: Hash
656
- default: "`{}`"
657
- description: "[Classes and attributes](/classes-attributes)"
658
- - component: SlideoverComponent
659
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/slideover_component.rb
660
- parameters:
661
- - name: tag
662
- type: Symbol, String
663
- default: "`:div`"
664
- description: The rendered tag name.
665
- - name: direction
666
- type: Symbol
667
- default: N/A
668
- description: One of `:xl` and `:yd`.
669
- - name: open_text
670
- type: String
671
- default: '`"Open"`'
672
- description: The text to use to open the slideover.
673
- - name: close_text
674
- type: String
675
- default: '`"Close"`'
676
- description: The text to use to close the slideover.
677
- - name: classes
678
- type: String
679
- default: '`""`'
680
- description: "[Classes and attributes](/classes-attributes)"
681
- - name: attributes
682
- type: Hash
683
- default: "`{}`"
684
- description: "[Classes and attributes](/classes-attributes)"
685
- - component: TabComponent
686
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_component.rb
687
- parameters:
688
- - name: id
689
- type: String
690
- default: "`nil`"
691
- description: The unique ID of the tab.
692
- - name: selected
693
- type: Boolean
694
- default: "`false`"
695
- description: Whether the tab is selected or not.
696
- - name: with_panel
697
- type: Boolean
698
- default: "`false`"
699
- description: Whether the Tab has an associated panel.
700
- - name: href
701
- type: String
702
- default: "`nil`"
703
- description: The link to navigate to when the tab is clicked.
704
- - name: classes
705
- type: String
706
- default: '`""`'
707
- description: "[Classes and attributes](/classes-attributes)"
708
- - name: attributes
709
- type: Hash
710
- default: "`{}`"
711
- description: "[Classes and attributes](/classes-attributes)"
712
- - component: TabContainerComponent
713
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_container_component.rb
714
- parameters:
715
- - name: sr_label
716
- type: String
717
- default: N/A
718
- description: Sets an `aria-label` that helps assistive technology users understand
719
- the purpose of the tabs.
720
- - name: classes
721
- type: String
722
- default: '`""`'
723
- description: "[Classes and attributes](/classes-attributes)"
724
- - name: attributes
725
- type: Hash
726
- default: "`{}`"
727
- description: "[Classes and attributes](/classes-attributes)"
728
- - component: TabNavComponent
729
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tab_nav_component.rb
730
- parameters:
731
- - name: label
732
- type: String
733
- default: N/A
734
- description: Sets an `aria-label` that helps assistive technology users understand
735
- the purpose of the links, and distinguish it from similar elements.
736
- - name: tag
737
- type: Symbol, String
738
- default: "`:nav`"
739
- description: The rendered tag name.
740
- - name: classes
741
- type: String
742
- default: '`""`'
743
- description: "[Classes and attributes](/classes-attributes)"
744
- - name: attributes
745
- type: Hash
746
- default: "`{}`"
747
- description: "[Classes and attributes](/classes-attributes)"
748
- - component: TableNavComponent
749
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/table_nav_component.rb
750
- parameters:
751
- - name: classes
752
- type: String
753
- default: '`""`'
754
- description: "[Classes and attributes](/classes-attributes)"
755
- - name: attributes
756
- type: Hash
757
- default: "`{}`"
758
- description: "[Classes and attributes](/classes-attributes)"
759
- - component: Text
760
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/text.rb
761
- parameters:
762
- - name: tag
763
- type: Symbol, String
764
- default: "`:span`"
765
- description: The rendered tag name
766
- - name: classes
767
- type: String
768
- default: '`""`'
769
- description: "[Classes and attributes](/classes-attributes)"
770
- - name: attributes
771
- type: Hash
772
- default: "`{}`"
773
- description: "[Classes and attributes](/classes-attributes)"
774
- - component: TimeAgoComponent
775
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/time_ago_component.rb
776
- parameters:
777
- - name: tag
778
- type: Symbol, String
779
- default: "`:time-ago`"
780
- description: The rendered tag name.
781
- - name: time
782
- type: Time
783
- default: N/A
784
- description: The time to be formatted
785
- - name: micro
786
- type: Boolean
787
- default: "`false`"
788
- description: If true then the text will be formatted in "micro" mode, using as
789
- few characters as possible
790
- - name: classes
791
- type: String
792
- default: '`""`'
793
- description: "<%= link_to_classes_docs %>"
794
- - name: attributes
795
- type: Hash
796
- default: "`{}`"
797
- description: "[Classes and attributes](/classes-attributes)"
798
- - component: TimelineComponent
799
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/timeline_component.rb
800
- parameters:
801
- - name: tag
802
- type: Symbol, String
803
- default: "`:div`"
804
- description: The rendered tag name
805
- - name: classes
806
- type: String
807
- default: '`""`'
808
- description: "[Classes and attributes](/classes-attributes)"
809
- - name: attributes
810
- type: Hash
811
- default: "`{}`"
812
- description: "[Classes and attributes](/classes-attributes)"
813
- - component: ToggleComponent
814
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/toggle_component.rb
815
- parameters:
816
- - name: classes
817
- type: String
818
- default: "`nil`"
819
- description: "[Classes and attributes](/classes-attributes)"
820
- - name: color
821
- type: String
822
- default: "`:indigo`"
823
- description: "[Classes and attributes](/classes-attributes)"
824
- - name: checked
825
- type: Boolean
826
- default: "`false`"
827
- description: "[Classes and attributes](/classes-attributes)"
828
- - name: disabled
829
- type: Boolean
830
- default: "`false`"
831
- description: "[Classes and attributes](/classes-attributes)"
832
- - name: size
833
- type: String
834
- default: "`:md`"
835
- description: "[Classes and attributes](/classes-attributes)"
836
- - name: label
837
- type: String
838
- default: N/A
839
- description: "[Classes and attributes](/classes-attributes)"
840
- - name: status_label_position
841
- type: String
842
- default: "`:start`"
843
- description: "[Classes and attributes](/classes-attributes)"
844
- - name: attributes
845
- type: Hash
846
- default: "`{}`"
847
- description: "[Classes and attributes](/classes-attributes)"
848
- - component: TooltipComponent
849
- source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/tooltip_component.rb
850
- parameters:
851
- - name: tag
852
- type: Symbol, String
853
- default: "`:tooltip`"
854
- description: The rendered tag name
855
- - name: for_id
856
- type: String
857
- default: N/A
858
- description: The ID of the element that the tooltip should be attached to.
859
- - name: text
860
- type: String
861
- default: N/A
862
- description: The text content of the tooltip. This should be brief and no longer
863
- than a sentence.
864
- - name: type
865
- type: Symbol
866
- default: "`:description`"
867
- description: One of `:description` and `:label`.
868
- - name: direction
869
- type: Symbol
870
- default: "`:top`"
871
- description: One of `:bottom`, `:left`, `:right`, or `:top`.
872
- - name: classes
873
- type: String
874
- default: '`""`'
875
- description: "[Classes and attributes](/classes-attributes)"
876
- - name: attributes
877
- type: Hash
878
- default: "`{}`"
879
- description: "[Classes and attributes](/classes-attributes)"