@openproject/primer-view-components 0.79.1 → 0.80.0-rc.84ac7694a

package/app/components/primer/open_project/inline_message.css

@@ -0,0 +1 @@
+.InlineMessage{align-items:start;color:var(--inline-message-fgColor);column-gap:.5rem;display:grid;font-size:var(--inline-message-fontSize);grid-template-columns:auto 1fr;line-height:var(--inline-message-lineHeight)}.InlineMessage[data-size=small]{--inline-message-fontSize:var(--text-body-size-small);--inline-message-lineHeight:var(--text-body-lineHeight-small,1.6666)}.InlineMessage[data-size=medium]{--inline-message-fontSize:var(--text-body-size-medium);--inline-message-lineHeight:var(--text-body-lineHeight-medium,1.4285)}.InlineMessage[data-variant=warning]{--inline-message-fgColor:var(--fgColor-attention)}.InlineMessage[data-variant=critical]{--inline-message-fgColor:var(--fgColor-danger)}.InlineMessage[data-variant=success]{--inline-message-fgColor:var(--fgColor-success)}.InlineMessage[data-variant=unavailable]{--inline-message-fgColor:var(--fgColor-muted)}.InlineMessageIcon{min-height:calc(var(--inline-message-lineHeight)*var(--inline-message-fontSize))}

package/app/components/primer/open_project/inline_message.css.json

@@ -0,0 +1,13 @@
+{
+  "name": "open_project/inline_message",
+  "selectors": [
+    ".InlineMessage",
+    ".InlineMessage[data-size=small]",
+    ".InlineMessage[data-size=medium]",
+    ".InlineMessage[data-variant=warning]",
+    ".InlineMessage[data-variant=critical]",
+    ".InlineMessage[data-variant=success]",
+    ".InlineMessage[data-variant=unavailable]",
+    ".InlineMessageIcon"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openproject/primer-view-components",
-  "version": "0.79.1",
+  "version": "0.80.0-rc.84ac7694a",
   "description": "ViewComponents of the Primer Design System for OpenProject",
   "main": "app/assets/javascripts/primer_view_components.js",
   "module": "app/components/primer/primer.js",

package/static/arguments.json

@@ -6058,6 +6058,43 @@
       }
     ]
   },
+  {
+    "component": "OpenProject::Fieldset",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectFieldset",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/fieldset.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/fieldset/default/",
+    "parameters": [
+      {
+        "name": "legend_text",
+        "type": "String",
+        "default": "`nil`",
+        "description": "A legend should be short and concise. The String will also be read by assistive technology."
+      },
+      {
+        "name": "visually_hide_legend",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Controls if the legend is visible. If `true`, screen reader only text will be added."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "OpenProject::Fieldset::Legend",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectFieldsetLegend",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/fieldset/legend_component.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/fieldset/legend/default/",
+    "parameters": []
+  },
   {
     "component": "OpenProject::FilterableTreeView",
     "status": "alpha",
@@ -6220,6 +6257,34 @@
       }
     ]
   },
+  {
+    "component": "OpenProject::InlineMessage",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectInlineMessage",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/inline_message.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/inline_message/default/",
+    "parameters": [
+      {
+        "name": "scheme",
+        "type": "Symbol",
+        "default": "N/A",
+        "description": "One of `:critical`, `:success`, `:unavailable`, or `:warning`."
+      },
+      {
+        "name": "size",
+        "type": "Symbol",
+        "default": "`:medium`",
+        "description": "One of `:medium` or `:small`."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "OpenProject::InputGroup",
     "status": "open_project",

package/static/audited_at.json

@@ -151,12 +151,15 @@
   "Primer::OpenProject::DragHandle": "",
   "Primer::OpenProject::FeedbackDialog": "",
   "Primer::OpenProject::FeedbackMessage": "",
+  "Primer::OpenProject::Fieldset": "",
+  "Primer::OpenProject::Fieldset::LegendComponent": "",
   "Primer::OpenProject::FilterableTreeView": "",
   "Primer::OpenProject::FilterableTreeView::SubTree": "",
   "Primer::OpenProject::FlexLayout": "",
   "Primer::OpenProject::GridLayout": "",
   "Primer::OpenProject::GridLayout::Area": "",
   "Primer::OpenProject::Heading": "",
+  "Primer::OpenProject::InlineMessage": "",
   "Primer::OpenProject::InputGroup": "",
   "Primer::OpenProject::PageHeader": "",
   "Primer::OpenProject::PageHeader::Dialog": "",

package/static/classes.json

@@ -352,6 +352,12 @@
   "FormControl-warning": [
     "Primer::Alpha::TextField"
   ],
+  "InlineMessage": [
+    "Primer::OpenProject::InlineMessage"
+  ],
+  "InlineMessageIcon": [
+    "Primer::OpenProject::InlineMessage"
+  ],
   "InputGroup": [
     "Primer::OpenProject::InputGroup"
   ],

package/static/constants.json

@@ -1751,6 +1751,13 @@
   "Primer::OpenProject::FeedbackMessage": {
     "GeneratedSlotMethods": "Primer::OpenProject::FeedbackMessage::GeneratedSlotMethods"
   },
+  "Primer::OpenProject::Fieldset": {
+    "GeneratedSlotMethods": "Primer::OpenProject::Fieldset::GeneratedSlotMethods",
+    "LegendComponent": "Primer::OpenProject::Fieldset::LegendComponent"
+  },
+  "Primer::OpenProject::Fieldset::LegendComponent": {
+    "GeneratedSlotMethods": "Primer::OpenProject::Fieldset::LegendComponent::GeneratedSlotMethods"
+  },
   "Primer::OpenProject::FilterableTreeView": {
     "DEFAULT_FILTER_INPUT_ARGUMENTS": {
       "name": "filter",
@@ -1810,6 +1817,20 @@
   "Primer::OpenProject::Heading": {
     "GeneratedSlotMethods": "Primer::OpenProject::Heading::GeneratedSlotMethods"
   },
+  "Primer::OpenProject::InlineMessage": {
+    "DEFAULT_SIZE": "medium",
+    "GeneratedSlotMethods": "Primer::OpenProject::InlineMessage::GeneratedSlotMethods",
+    "SCHEME_OPTIONS": [
+      "warning",
+      "critical",
+      "success",
+      "unavailable"
+    ],
+    "SIZE_OPTIONS": [
+      "small",
+      "medium"
+    ]
+  },
   "Primer::OpenProject::InputGroup": {
     "DEFAULT_INPUT_WIDTH": "auto",
     "GeneratedSlotMethods": "Primer::OpenProject::InputGroup::GeneratedSlotMethods",
@@ -1845,6 +1866,7 @@
       "none",
       "flex"
     ],
+    "DEFAULT_BUTTON_ACTION_SIZE": "medium",
     "DEFAULT_HEADER_VARIANT": "medium",
     "DEFAULT_LEADING_ACTION_DISPLAY": [
       "none",

package/static/form_previews.json

@@ -18,6 +18,11 @@
         "name": "custom_width_fields_form",
         "snapshot": "false"
       },
+      {
+        "preview_path": "primer/forms/fieldset_group_form",
+        "name": "fieldset_group_form",
+        "snapshot": "true"
+      },
       {
         "preview_path": "primer/forms/text_field_and_checkbox_form",
         "name": "text_field_and_checkbox_form",

package/static/info_arch.json

@@ -20079,6 +20079,83 @@
     ],
     "subcomponents": []
   },
+  {
+    "fully_qualified_name": "Primer::OpenProject::Fieldset",
+    "description": "A low-level component for building fieldsets with unopinionated styling.\n\nThis component is not designed to be used directly, but rather a primitive for\nauthors of other components and form controls.",
+    "accessibility_docs": null,
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
+    "component": "OpenProject::Fieldset",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectFieldset",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/fieldset.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/fieldset/default/",
+    "parameters": [
+      {
+        "name": "legend_text",
+        "type": "String",
+        "default": "`nil`",
+        "description": "A legend should be short and concise. The String will also be read by assistive technology."
+      },
+      {
+        "name": "visually_hide_legend",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Controls if the legend is visible. If `true`, screen reader only text will be added."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "{{link_to_system_arguments_docs}}"
+      }
+    ],
+    "slots": [
+      {
+        "name": "legend",
+        "description": null,
+        "parameters": []
+      }
+    ],
+    "methods": [
+      {
+        "name": "legend_text",
+        "description": "Returns the value of attribute legend_text.",
+        "parameters": [],
+        "return_types": []
+      }
+    ],
+    "previews": [],
+    "subcomponents": []
+  },
+  {
+    "fully_qualified_name": "Primer::OpenProject::Fieldset::LegendComponent",
+    "description": "",
+    "accessibility_docs": null,
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
+    "component": "OpenProject::Fieldset::Legend",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectFieldsetLegend",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/fieldset/legend_component.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/fieldset/legend/default/",
+    "parameters": [],
+    "slots": [],
+    "methods": [
+      {
+        "name": "text",
+        "description": "Returns the value of attribute text.",
+        "parameters": [],
+        "return_types": []
+      }
+    ],
+    "previews": [],
+    "subcomponents": []
+  },
   {
     "fully_qualified_name": "Primer::OpenProject::FilterableTreeView",
     "description": "A TreeView and associated filter controls for searching nested hierarchies.\n\n## Filter controls\n\n`FilterableTreeView`s can be filtered using two controls, both present in the toolbar above the tree:\n\n1. A free-form query string from a text input field.\n2. A `SegmentedControl` with two options (by default):\n   1. The \"Selected\" option causes the component to only show checked nodes, provided they also satisfy the other\n      filter criteria described here.\n   2. The \"All\" option causes the component to show all nodes, provided they also satisfy the other filter\n      criteria described here.\n\n## Custom filter modes\n\nIn addition to the default filter modes of `'all'` and `'selected'` described above, `FilterableTreeView` supports\nadding custom filter modes. Adding a filter mode will cause its label to appear in the `SegmentedControl` in the\ntoolbar, and will be passed as the third argument to the filter function (see below).\n\nHere's how to add a custom filter mode in addition to the default ones:\n\n```erb\n<%= render(Primer::OpenProject::FilterableTreeView.new) do |tree_view| %>\n  <%# remove this line to prevent adding the default modes %>\n  <% tree_view.with_default_filter_modes %>\n  <% tree_view.with_filter_mode(name: \"Custom\", system_arguments)\n<% end %>\n```\n\n## Filter behavior\n\nBy default, matching node text is identified by looking for an exact substring match, operating on a lowercased\nversion of both the query string and the node text. For more information, and to provide a customized filter\nfunction, please see the section titled \"Customizing the filter function\" below.\n\nNodes that match the filter appear as normal; nodes that do not match are presented as follows:\n\n1. Leaf nodes are hidden.\n2. Sub-tree nodes with no matching children are hidden.\n3. Sub-tree nodes with at least one matching child are disabled but still visible.\n\n## Checking behavior\n\nBy default, checking a node in a `FilterableTreeView` checks only that node (i.e. no child nodes are checked).\nTo aide in checking children in deeply nested or highly populated hierarchies, a third control exists in the\ntoolbar: the \"Include sub-items\" check box. If this feature is turned on, checking sub-tree nodes causes all\nchildren, both leaf and sub-tree nodes, to also be checked recursively. Moreover, turning this feature on will\ncause the children of any previously checked nodes to be checked recursively. Unchecking a node while in\n\"Include sub-items\" mode will restore that sub-tree and all its children to their previously checked state, so as\nnot to permanently override a user's selections. Unchecking the \"Include sub-items\" check box has a similar effect,\ni.e. restores all previous user selections under currently checked sub-trees.\n\n## JavaScript API\n\n`FilterableTreeView` does not yet have an extensive JavaScript API, but this may change in the future as the\ncomponent is further developed to fit additional use-cases.\n\n### Customizing the filter function\n\nThe filter function can be customized by setting the value of the `filterFn` property to a function with the\nfollowing signature:\n\n```typescript\nexport type FilterFn = (node: HTMLElement, query: string, filterMode?: string) => Range[] | null\n```\n\nThis function will be called once for each node in the tree every time filter controls change (i.e. when the\nfilter mode or query string are altered). The function is called with the following arguments:\n\n|Argument    |Description                                                      |\n|:-----------|:----------------------------------------------------------------|\n|`node`      |The HTML node element, i.e. the element with `role=treeitem` set.|\n|`query`     |The query string.                                                |\n|`filterMode`|The filter mode, either `'all'` or `'selected'`.                 |\n\nThe component expects the filter function to return specific values depending on the type of match:\n\n1. No match - return `null`\n2. Match but no highlights (eg. when the query string is empty) - return an empty array\n3. Match with highlights - return a non-empty array of `Range` objects\n\nExample:\n\n```javascript\nconst filterableTreeView = document.querySelector('filterable-tree-view')\nfilterableTreeView.filterFn = (node, query, filterMode) => {\n  // custom filter implementation here\n}\n```\n\nYou can read about `Range` objects here: https://developer.mozilla.org/en-US/docs/Web/API/Range.\n\nFor a complete example demonstrating how to implement a working filter function complete with range highlighting,\nsee the default filter function available in the `FilterableTreeViewElement` JavaScript class, which is part of\nthe Primer source code.\n\n### Events\n\nCurrently `FilterableTreeView` does not emit any events aside from the events already emitted by the `TreeView`\ncomponent.",
@@ -20571,6 +20648,71 @@
     ],
     "subcomponents": []
   },
+  {
+    "fully_qualified_name": "Primer::OpenProject::InlineMessage",
+    "description": "A simple component to render warning text.\n\nThe warning text is rendered in the \"attention\" Primer color and\nuses a leading alert Octicon for additional emphasis. This component\nis designed to be used \"inline\", e.g. table cells, and in places\nwhere a Banner component might be overkill.",
+    "accessibility_docs": null,
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
+    "component": "OpenProject::InlineMessage",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectInlineMessage",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/inline_message.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/inline_message/default/",
+    "parameters": [
+      {
+        "name": "scheme",
+        "type": "Symbol",
+        "default": "N/A",
+        "description": "One of `:critical`, `:success`, `:unavailable`, or `:warning`."
+      },
+      {
+        "name": "size",
+        "type": "Symbol",
+        "default": "`:medium`",
+        "description": "One of `:medium` or `:small`."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "{{link_to_system_arguments_docs}}"
+      }
+    ],
+    "slots": [],
+    "methods": [],
+    "previews": [
+      {
+        "preview_path": "primer/open_project/inline_message/default",
+        "name": "default",
+        "snapshot": "true",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/inline_message/playground",
+        "name": "playground",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      }
+    ],
+    "subcomponents": []
+  },
   {
     "fully_qualified_name": "Primer::OpenProject::InputGroup",
     "description": "`InputGroup` is composed of a text field input with a trailing action",

package/static/previews.json

@@ -5104,6 +5104,40 @@
       }
     ]
   },
+  {
+    "name": "inline_message",
+    "component": "OpenProject::InlineMessage",
+    "status": "open_project",
+    "lookup_path": "primer/open_project/inline_message",
+    "examples": [
+      {
+        "preview_path": "primer/open_project/inline_message/default",
+        "name": "default",
+        "snapshot": "true",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/inline_message/playground",
+        "name": "playground",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      }
+    ]
+  },
   {
     "name": "input_group",
     "component": "OpenProject::InputGroup",

package/static/statuses.json

@@ -151,12 +151,15 @@
   "Primer::OpenProject::DragHandle": "open_project",
   "Primer::OpenProject::FeedbackDialog": "open_project",
   "Primer::OpenProject::FeedbackMessage": "open_project",
+  "Primer::OpenProject::Fieldset": "open_project",
+  "Primer::OpenProject::Fieldset::LegendComponent": "open_project",
   "Primer::OpenProject::FilterableTreeView": "alpha",
   "Primer::OpenProject::FilterableTreeView::SubTree": "alpha",
   "Primer::OpenProject::FlexLayout": "open_project",
   "Primer::OpenProject::GridLayout": "open_project",
   "Primer::OpenProject::GridLayout::Area": "open_project",
   "Primer::OpenProject::Heading": "open_project",
+  "Primer::OpenProject::InlineMessage": "open_project",
   "Primer::OpenProject::InputGroup": "open_project",
   "Primer::OpenProject::PageHeader": "open_project",
   "Primer::OpenProject::PageHeader::Dialog": "open_project",