@openproject/primer-view-components 0.62.0 → 0.63.0-rc.ef3e3e44e

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": "@openproject/primer-view-components",
3
- "version": "0.62.0",
3
+ "version": "0.63.0-rc.ef3e3e44e",
4
4
  "description": "ViewComponents of the Primer Design System for OpenProject",
5
5
  "main": "app/assets/javascripts/primer_view_components.js",
6
6
  "module": "app/components/primer/primer.js",
@@ -49,7 +49,7 @@
49
49
  "@github/clipboard-copy-element": "^1.3.0",
50
50
  "@github/details-menu-element": "^1.0.12",
51
51
  "@github/image-crop-element": "^5.0.0",
52
- "@github/include-fragment-element": "^6.1.1",
52
+ "@github/include-fragment-element": "^6.3.0",
53
53
  "@github/relative-time-element": "^4.0.0",
54
54
  "@github/remote-input-element": "^0.4.0",
55
55
  "@github/tab-container-element": "^3.1.2",
@@ -1357,6 +1357,34 @@
1357
1357
  }
1358
1358
  ]
1359
1359
  },
1360
+ {
1361
+ "component": "IncludeFragment",
1362
+ "status": "alpha",
1363
+ "a11y_reviewed": false,
1364
+ "short_name": "IncludeFragment",
1365
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/include_fragment.rb",
1366
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default/",
1367
+ "parameters": [
1368
+ {
1369
+ "name": "src",
1370
+ "type": "String",
1371
+ "default": "`nil`",
1372
+ "description": "The URL from which to retrieve an HTML element fragment."
1373
+ },
1374
+ {
1375
+ "name": "loading",
1376
+ "type": "Symbol",
1377
+ "default": "`:eager`",
1378
+ "description": "One of `:eager` or `:lazy`."
1379
+ },
1380
+ {
1381
+ "name": "system_arguments",
1382
+ "type": "Hash",
1383
+ "default": "N/A",
1384
+ "description": "[System arguments](/system-arguments)"
1385
+ }
1386
+ ]
1387
+ },
1360
1388
  {
1361
1389
  "component": "Layout",
1362
1390
  "status": "alpha",
@@ -4949,13 +4977,19 @@
4949
4977
  "name": "condition",
4950
4978
  "type": "Boolean",
4951
4979
  "default": "N/A",
4952
- "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
4980
+ "description": "Whether or not to wrap the content in a component."
4981
+ },
4982
+ {
4983
+ "name": "component",
4984
+ "type": "Class",
4985
+ "default": "`Primer::BaseComponent`",
4986
+ "description": "The component class to use as a wrapper, defaults to `Primer::BaseComponent`"
4953
4987
  },
4954
4988
  {
4955
4989
  "name": "base_component_arguments",
4956
4990
  "type": "Hash",
4957
4991
  "default": "N/A",
4958
- "description": "The arguments to pass to `Primer::BaseComponent`."
4992
+ "description": "The arguments to pass to the component."
4959
4993
  }
4960
4994
  ]
4961
4995
  },
@@ -30,6 +30,7 @@
30
30
  "Primer::Alpha::HellipButton": "",
31
31
  "Primer::Alpha::HiddenTextExpander": "",
32
32
  "Primer::Alpha::Image": "",
33
+ "Primer::Alpha::IncludeFragment": "",
33
34
  "Primer::Alpha::Layout": "",
34
35
  "Primer::Alpha::Layout::Main": "",
35
36
  "Primer::Alpha::Layout::Sidebar": "",
@@ -391,6 +391,9 @@
391
391
  "Primer::Alpha::Image": {
392
392
  "GeneratedSlotMethods": "Primer::Alpha::Image::GeneratedSlotMethods"
393
393
  },
394
+ "Primer::Alpha::IncludeFragment": {
395
+ "GeneratedSlotMethods": "Primer::Alpha::IncludeFragment::GeneratedSlotMethods"
396
+ },
394
397
  "Primer::Alpha::Layout": {
395
398
  "FIRST_IN_SOURCE_DEFAULT": "sidebar",
396
399
  "FIRST_IN_SOURCE_OPTIONS": [
@@ -4679,6 +4679,77 @@
4679
4679
 
4680
4680
  ]
4681
4681
  },
4682
+ {
4683
+ "fully_qualified_name": "Primer::Alpha::IncludeFragment",
4684
+ "description": "Use `IncludeFragment` to load HTML elements from the server.\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
4685
+ "accessibility_docs": "Add any accessibility considerations",
4686
+ "is_form_component": false,
4687
+ "is_published": true,
4688
+ "requires_js": false,
4689
+ "component": "IncludeFragment",
4690
+ "status": "alpha",
4691
+ "a11y_reviewed": false,
4692
+ "short_name": "IncludeFragment",
4693
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/include_fragment.rb",
4694
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default/",
4695
+ "parameters": [
4696
+ {
4697
+ "name": "src",
4698
+ "type": "String",
4699
+ "default": "`nil`",
4700
+ "description": "The URL from which to retrieve an HTML element fragment."
4701
+ },
4702
+ {
4703
+ "name": "loading",
4704
+ "type": "Symbol",
4705
+ "default": "`:eager`",
4706
+ "description": "One of `:eager` or `:lazy`."
4707
+ },
4708
+ {
4709
+ "name": "system_arguments",
4710
+ "type": "Hash",
4711
+ "default": "N/A",
4712
+ "description": "{{link_to_system_arguments_docs}}"
4713
+ }
4714
+ ],
4715
+ "slots": [
4716
+
4717
+ ],
4718
+ "methods": [
4719
+
4720
+ ],
4721
+ "previews": [
4722
+ {
4723
+ "preview_path": "primer/alpha/include_fragment/playground",
4724
+ "name": "playground",
4725
+ "snapshot": "false",
4726
+ "skip_rules": {
4727
+ "wont_fix": [
4728
+ "region"
4729
+ ],
4730
+ "will_fix": [
4731
+ "color-contrast"
4732
+ ]
4733
+ }
4734
+ },
4735
+ {
4736
+ "preview_path": "primer/alpha/include_fragment/default",
4737
+ "name": "default",
4738
+ "snapshot": "false",
4739
+ "skip_rules": {
4740
+ "wont_fix": [
4741
+ "region"
4742
+ ],
4743
+ "will_fix": [
4744
+ "color-contrast"
4745
+ ]
4746
+ }
4747
+ }
4748
+ ],
4749
+ "subcomponents": [
4750
+
4751
+ ]
4752
+ },
4682
4753
  {
4683
4754
  "fully_qualified_name": "Primer::Alpha::Layout",
4684
4755
  "description": "`Layout` provides foundational patterns for responsive pages.\n`Layout` can be used for simple two-column pages, or it can be nested to provide flexible 3-column experiences.\n On smaller screens, `Layout` uses vertically stacked rows to display content.\n\n`Layout` flows as both column, when there's enough horizontal space to render both `Main` and `Sidebar`side-by-side (on a desktop of tablet device, per instance);\nor it flows as a row, when `Main` and `Sidebar` are stacked vertically (e.g. on a mobile device).\n`Layout` should always work in any screen size.",
@@ -17220,7 +17291,7 @@
17220
17291
  },
17221
17292
  {
17222
17293
  "fully_qualified_name": "Primer::ConditionalWrapper",
17223
- "description": "Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition\nis true, a `Primer::BaseComponent` will render around the content. If the condition is false, only\nthe content is rendered.",
17294
+ "description": "Conditionally renders a component around the given content. If the given condition\nis true, the component will render around the content. If the condition is false, only\nthe content is rendered.",
17224
17295
  "accessibility_docs": null,
17225
17296
  "is_form_component": false,
17226
17297
  "is_published": true,
@@ -17236,13 +17307,19 @@
17236
17307
  "name": "condition",
17237
17308
  "type": "Boolean",
17238
17309
  "default": "N/A",
17239
- "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
17310
+ "description": "Whether or not to wrap the content in a component."
17311
+ },
17312
+ {
17313
+ "name": "component",
17314
+ "type": "Class",
17315
+ "default": "`Primer::BaseComponent`",
17316
+ "description": "The component class to use as a wrapper, defaults to `Primer::BaseComponent`"
17240
17317
  },
17241
17318
  {
17242
17319
  "name": "base_component_arguments",
17243
17320
  "type": "Hash",
17244
17321
  "default": "N/A",
17245
- "description": "The arguments to pass to `Primer::BaseComponent`."
17322
+ "description": "The arguments to pass to the component."
17246
17323
  }
17247
17324
  ],
17248
17325
  "slots": [
@@ -4682,6 +4682,40 @@
4682
4682
  }
4683
4683
  ]
4684
4684
  },
4685
+ {
4686
+ "name": "include_fragment",
4687
+ "component": "IncludeFragment",
4688
+ "status": "alpha",
4689
+ "lookup_path": "primer/alpha/include_fragment",
4690
+ "examples": [
4691
+ {
4692
+ "preview_path": "primer/alpha/include_fragment/playground",
4693
+ "name": "playground",
4694
+ "snapshot": "false",
4695
+ "skip_rules": {
4696
+ "wont_fix": [
4697
+ "region"
4698
+ ],
4699
+ "will_fix": [
4700
+ "color-contrast"
4701
+ ]
4702
+ }
4703
+ },
4704
+ {
4705
+ "preview_path": "primer/alpha/include_fragment/default",
4706
+ "name": "default",
4707
+ "snapshot": "false",
4708
+ "skip_rules": {
4709
+ "wont_fix": [
4710
+ "region"
4711
+ ],
4712
+ "will_fix": [
4713
+ "color-contrast"
4714
+ ]
4715
+ }
4716
+ }
4717
+ ]
4718
+ },
4685
4719
  {
4686
4720
  "name": "input_group",
4687
4721
  "component": "OpenProject::InputGroup",
@@ -30,6 +30,7 @@
30
30
  "Primer::Alpha::HellipButton": "alpha",
31
31
  "Primer::Alpha::HiddenTextExpander": "alpha",
32
32
  "Primer::Alpha::Image": "alpha",
33
+ "Primer::Alpha::IncludeFragment": "alpha",
33
34
  "Primer::Alpha::Layout": "alpha",
34
35
  "Primer::Alpha::Layout::Main": "alpha",
35
36
  "Primer::Alpha::Layout::Sidebar": "alpha",