@primer/view-components 0.6.0-rc.897d06d1 → 0.6.0-rc.955257c0
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@primer/view-components",
|
|
3
|
-
"version": "0.6.0-rc.
|
|
3
|
+
"version": "0.6.0-rc.955257c0",
|
|
4
4
|
"description": "ViewComponents for the Primer Design System",
|
|
5
5
|
"main": "app/assets/javascripts/primer_view_components.js",
|
|
6
6
|
"module": "app/components/primer/primer.js",
|
package/static/info_arch.json
CHANGED
|
@@ -270,17 +270,11 @@
|
|
|
270
270
|
"name": "with_item",
|
|
271
271
|
"description": "Adds an item to the list.",
|
|
272
272
|
"parameters": [
|
|
273
|
-
{
|
|
274
|
-
"name": "component_klass",
|
|
275
|
-
"type": "Class",
|
|
276
|
-
"default": "N/A",
|
|
277
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
|
278
|
-
},
|
|
279
273
|
{
|
|
280
274
|
"name": "system_arguments",
|
|
281
275
|
"type": "Hash",
|
|
282
276
|
"default": "N/A",
|
|
283
|
-
"description": "
|
|
277
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
284
278
|
}
|
|
285
279
|
]
|
|
286
280
|
},
|
|
@@ -324,23 +318,17 @@
|
|
|
324
318
|
"default": "`:block`",
|
|
325
319
|
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
|
326
320
|
},
|
|
327
|
-
{
|
|
328
|
-
"name": "component_klass",
|
|
329
|
-
"type": "Class",
|
|
330
|
-
"default": "`ActionList::Item`",
|
|
331
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
|
332
|
-
},
|
|
333
321
|
{
|
|
334
322
|
"name": "avatar_arguments",
|
|
335
323
|
"type": "Hash",
|
|
336
324
|
"default": "`{}`",
|
|
337
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
|
325
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}."
|
|
338
326
|
},
|
|
339
327
|
{
|
|
340
328
|
"name": "system_arguments",
|
|
341
329
|
"type": "Hash",
|
|
342
330
|
"default": "N/A",
|
|
343
|
-
"description": "
|
|
331
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
344
332
|
}
|
|
345
333
|
]
|
|
346
334
|
},
|
|
@@ -365,72 +353,6 @@
|
|
|
365
353
|
|
|
366
354
|
]
|
|
367
355
|
},
|
|
368
|
-
{
|
|
369
|
-
"name": "build_item",
|
|
370
|
-
"description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
|
|
371
|
-
"parameters": [
|
|
372
|
-
{
|
|
373
|
-
"name": "component_klass",
|
|
374
|
-
"type": "Class",
|
|
375
|
-
"default": "`ActionList::Item`",
|
|
376
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
|
377
|
-
},
|
|
378
|
-
{
|
|
379
|
-
"name": "system_arguments",
|
|
380
|
-
"type": "Hash",
|
|
381
|
-
"default": "N/A",
|
|
382
|
-
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
383
|
-
}
|
|
384
|
-
]
|
|
385
|
-
},
|
|
386
|
-
{
|
|
387
|
-
"name": "build_avatar_item",
|
|
388
|
-
"description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
|
|
389
|
-
"parameters": [
|
|
390
|
-
{
|
|
391
|
-
"name": "src",
|
|
392
|
-
"type": "String",
|
|
393
|
-
"default": "N/A",
|
|
394
|
-
"description": "The source url of the avatar image."
|
|
395
|
-
},
|
|
396
|
-
{
|
|
397
|
-
"name": "username",
|
|
398
|
-
"type": "String",
|
|
399
|
-
"default": "N/A",
|
|
400
|
-
"description": "The username associated with the avatar."
|
|
401
|
-
},
|
|
402
|
-
{
|
|
403
|
-
"name": "full_name",
|
|
404
|
-
"type": "String",
|
|
405
|
-
"default": "`nil`",
|
|
406
|
-
"description": "Optional. The user's full name."
|
|
407
|
-
},
|
|
408
|
-
{
|
|
409
|
-
"name": "full_name_scheme",
|
|
410
|
-
"type": "Symbol",
|
|
411
|
-
"default": "`:block`",
|
|
412
|
-
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
|
413
|
-
},
|
|
414
|
-
{
|
|
415
|
-
"name": "component_klass",
|
|
416
|
-
"type": "Class",
|
|
417
|
-
"default": "`ActionList::Item`",
|
|
418
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
|
419
|
-
},
|
|
420
|
-
{
|
|
421
|
-
"name": "avatar_arguments",
|
|
422
|
-
"type": "Hash",
|
|
423
|
-
"default": "`{}`",
|
|
424
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
|
425
|
-
},
|
|
426
|
-
{
|
|
427
|
-
"name": "system_arguments",
|
|
428
|
-
"type": "Hash",
|
|
429
|
-
"default": "N/A",
|
|
430
|
-
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
431
|
-
}
|
|
432
|
-
]
|
|
433
|
-
},
|
|
434
356
|
{
|
|
435
357
|
"name": "post_list_content_block",
|
|
436
358
|
"description": "Returns the value of attribute post_list_content_block.",
|
|
@@ -1704,7 +1626,7 @@
|
|
|
1704
1626
|
"name": "system_arguments",
|
|
1705
1627
|
"type": "Hash",
|
|
1706
1628
|
"default": "N/A",
|
|
1707
|
-
"description": "
|
|
1629
|
+
"description": "The same arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
1708
1630
|
}
|
|
1709
1631
|
]
|
|
1710
1632
|
},
|
|
@@ -1752,7 +1674,7 @@
|
|
|
1752
1674
|
"name": "system_arguments",
|
|
1753
1675
|
"type": "Hash",
|
|
1754
1676
|
"default": "N/A",
|
|
1755
|
-
"description": "
|
|
1677
|
+
"description": "The same arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
1756
1678
|
}
|
|
1757
1679
|
]
|
|
1758
1680
|
}
|
|
@@ -4865,14 +4787,14 @@
|
|
|
4865
4787
|
{
|
|
4866
4788
|
"name": "component_klass",
|
|
4867
4789
|
"type": "Class",
|
|
4868
|
-
"default": "
|
|
4869
|
-
"description": "The class to use
|
|
4790
|
+
"default": "N/A",
|
|
4791
|
+
"description": "The component class to use. Defaults to `Primer::Alpha::NavList::Item`."
|
|
4870
4792
|
},
|
|
4871
4793
|
{
|
|
4872
4794
|
"name": "system_arguments",
|
|
4873
4795
|
"type": "Hash",
|
|
4874
4796
|
"default": "N/A",
|
|
4875
|
-
"description": "
|
|
4797
|
+
"description": "The arguments accepted by the `component_klass` class."
|
|
4876
4798
|
}
|
|
4877
4799
|
]
|
|
4878
4800
|
},
|
|
@@ -4907,20 +4829,20 @@
|
|
|
4907
4829
|
{
|
|
4908
4830
|
"name": "component_klass",
|
|
4909
4831
|
"type": "Class",
|
|
4910
|
-
"default": "
|
|
4911
|
-
"description": "The class to use
|
|
4832
|
+
"default": "N/A",
|
|
4833
|
+
"description": "The component class to use. Defaults to `Primer::Alpha::NavList::Item`."
|
|
4912
4834
|
},
|
|
4913
4835
|
{
|
|
4914
4836
|
"name": "avatar_arguments",
|
|
4915
4837
|
"type": "Hash",
|
|
4916
4838
|
"default": "`{}`",
|
|
4917
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
|
4839
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}."
|
|
4918
4840
|
},
|
|
4919
4841
|
{
|
|
4920
4842
|
"name": "system_arguments",
|
|
4921
4843
|
"type": "Hash",
|
|
4922
4844
|
"default": "N/A",
|
|
4923
|
-
"description": "
|
|
4845
|
+
"description": "The arguments accepted by the `component_klass` class."
|
|
4924
4846
|
}
|
|
4925
4847
|
]
|
|
4926
4848
|
},
|
|
@@ -4948,72 +4870,6 @@
|
|
|
4948
4870
|
}
|
|
4949
4871
|
]
|
|
4950
4872
|
},
|
|
4951
|
-
{
|
|
4952
|
-
"name": "build_item",
|
|
4953
|
-
"description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
|
|
4954
|
-
"parameters": [
|
|
4955
|
-
{
|
|
4956
|
-
"name": "component_klass",
|
|
4957
|
-
"type": "Class",
|
|
4958
|
-
"default": "`Primer::Alpha::NavList::Item`",
|
|
4959
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
|
4960
|
-
},
|
|
4961
|
-
{
|
|
4962
|
-
"name": "system_arguments",
|
|
4963
|
-
"type": "Hash",
|
|
4964
|
-
"default": "N/A",
|
|
4965
|
-
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
4966
|
-
}
|
|
4967
|
-
]
|
|
4968
|
-
},
|
|
4969
|
-
{
|
|
4970
|
-
"name": "build_avatar_item",
|
|
4971
|
-
"description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
|
|
4972
|
-
"parameters": [
|
|
4973
|
-
{
|
|
4974
|
-
"name": "src",
|
|
4975
|
-
"type": "String",
|
|
4976
|
-
"default": "N/A",
|
|
4977
|
-
"description": "The source url of the avatar image."
|
|
4978
|
-
},
|
|
4979
|
-
{
|
|
4980
|
-
"name": "username",
|
|
4981
|
-
"type": "String",
|
|
4982
|
-
"default": "N/A",
|
|
4983
|
-
"description": "The username associated with the avatar."
|
|
4984
|
-
},
|
|
4985
|
-
{
|
|
4986
|
-
"name": "full_name",
|
|
4987
|
-
"type": "String",
|
|
4988
|
-
"default": "`nil`",
|
|
4989
|
-
"description": "Optional. The user's full name."
|
|
4990
|
-
},
|
|
4991
|
-
{
|
|
4992
|
-
"name": "full_name_scheme",
|
|
4993
|
-
"type": "Symbol",
|
|
4994
|
-
"default": "`:block`",
|
|
4995
|
-
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
|
4996
|
-
},
|
|
4997
|
-
{
|
|
4998
|
-
"name": "component_klass",
|
|
4999
|
-
"type": "Class",
|
|
5000
|
-
"default": "`Primer::Alpha::NavList::Item`",
|
|
5001
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
|
5002
|
-
},
|
|
5003
|
-
{
|
|
5004
|
-
"name": "avatar_arguments",
|
|
5005
|
-
"type": "Hash",
|
|
5006
|
-
"default": "`{}`",
|
|
5007
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
|
5008
|
-
},
|
|
5009
|
-
{
|
|
5010
|
-
"name": "system_arguments",
|
|
5011
|
-
"type": "Hash",
|
|
5012
|
-
"default": "N/A",
|
|
5013
|
-
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
5014
|
-
}
|
|
5015
|
-
]
|
|
5016
|
-
},
|
|
5017
4873
|
{
|
|
5018
4874
|
"name": "render_outer_list?",
|
|
5019
4875
|
"description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
|