@openproject/primer-view-components 0.52.1-rc.e866fb53 → 0.52.1

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.52.1-rc.e866fb53",
3
+ "version": "0.52.1",
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",
@@ -5117,7 +5117,7 @@
5117
5117
  "name": "form_arguments",
5118
5118
  "type": "Hash",
5119
5119
  "default": "`{}`",
5120
- "description": "Allows the dialog to submit a form. Pass EITHER the `builder:` option to this hash"
5120
+ "description": "Allows the dialog to submit a form. Pass EITHER the `builder:` option to this hash to reuse an existing Rails form, or `action:` if you prefer the component to render the form tag itself. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which is created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
5121
5121
  },
5122
5122
  {
5123
5123
  "name": "id",
@@ -17453,7 +17453,7 @@
17453
17453
  "name": "form_arguments",
17454
17454
  "type": "Hash",
17455
17455
  "default": "`{}`",
17456
- "description": "Allows the dialog to submit a form. Pass EITHER the `builder:` option to this hash"
17456
+ "description": "Allows the dialog to submit a form. Pass EITHER the `builder:` option to this hash to reuse an existing Rails form, or `action:` if you prefer the component to render the form tag itself. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which is created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
17457
17457
  },
17458
17458
  {
17459
17459
  "name": "id",
@@ -17471,20 +17471,8 @@
17471
17471
  "slots": [
17472
17472
  {
17473
17473
  "name": "confirmation_message",
17474
- "description": "A confirmation message with some defaults that are necessary for rendering nicely.",
17474
+ "description": "A confirmation message with some defaults that are necessary for rendering nicely.\n\nTo render the message heading (required), call the `with_heading` method, which accepts a `:tag` argument, along with the arguments accepted by {{#link_to_component}}Primer::Beta::Heading{{/link_to_component}}.\n\nTo render the message description, call the `with_description` method, which accepts {{link_to_system_arguments_docs}}",
17475
17475
  "parameters": [
17476
- {
17477
- "name": "heading",
17478
- "type": "String",
17479
- "default": "N/A",
17480
- "description": "the heading for the success message"
17481
- },
17482
- {
17483
- "name": "description",
17484
- "type": "String",
17485
- "default": "N/A",
17486
- "description": "the description for the success message"
17487
- },
17488
17476
  {
17489
17477
  "name": "icon_arguments",
17490
17478
  "type": "Hash",
@@ -17501,7 +17489,7 @@
17501
17489
  },
17502
17490
  {
17503
17491
  "name": "confirmation_check_box",
17504
- "description": "A checkbox that the user is required to check in order to continue with the destructive action.",
17492
+ "description": "A checkbox that the user is required to check in order to continue with the destructive action.\n\nTo render the checkbox label (required), pass a block that returns a String.",
17505
17493
  "parameters": [
17506
17494
  {
17507
17495
  "name": "system_arguments",
@@ -17513,7 +17501,7 @@
17513
17501
  },
17514
17502
  {
17515
17503
  "name": "additional_details",
17516
- "description": "Optional additional_details such as grid displaying a list of items to be deleted",
17504
+ "description": "Optional additional details, such as grid displaying a list of items to be deleted",
17517
17505
  "parameters": [
17518
17506
  {
17519
17507
  "name": "system_arguments",
@@ -17778,20 +17766,8 @@
17778
17766
  "slots": [
17779
17767
  {
17780
17768
  "name": "feedback_message",
17781
- "description": "A feedback message with some defaults that are necessary for rendering nicely",
17769
+ "description": "A feedback message with some defaults that are necessary for rendering nicely.\n\nTo render the message heading (required), call the `with_heading` method, which accepts a `:tag` argument, along with the arguments accepted by {{#link_to_component}}Primer::Beta::Heading{{/link_to_component}}.\n\nTo render the message description, call the `with_description` method, which accepts {{link_to_system_arguments_docs}}",
17782
17770
  "parameters": [
17783
- {
17784
- "name": "heading",
17785
- "type": "String",
17786
- "default": "N/A",
17787
- "description": "the heading for the success message"
17788
- },
17789
- {
17790
- "name": "description",
17791
- "type": "String",
17792
- "default": "N/A",
17793
- "description": "the description for the success message"
17794
- },
17795
17771
  {
17796
17772
  "name": "icon_arguments",
17797
17773
  "type": "Hash",
@@ -17808,7 +17784,7 @@
17808
17784
  },
17809
17785
  {
17810
17786
  "name": "additional_details",
17811
- "description": "Optional additional_details like a form input or toast.",
17787
+ "description": "Optional additional details, like a form input or toast.",
17812
17788
  "parameters": [
17813
17789
  {
17814
17790
  "name": "system_arguments",