@openproject/primer-view-components 0.27.0-rc.ed6bcf82 → 0.28.0-rc.6db1fc3c

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.
@@ -0,0 +1,13 @@
1
+ declare class ZenModeButtonElement extends HTMLElement {
2
+ button: HTMLElement;
3
+ inZenMode: boolean;
4
+ private deactivateZenMode;
5
+ private activateZenMode;
6
+ performAction(): void;
7
+ }
8
+ declare global {
9
+ interface Window {
10
+ ZenModeButtonElement: typeof ZenModeButtonElement;
11
+ }
12
+ }
13
+ export {};
@@ -0,0 +1,45 @@
1
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
2
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
3
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
4
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
5
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
6
+ };
7
+ import { controller, target } from '@github/catalyst';
8
+ let ZenModeButtonElement = class ZenModeButtonElement extends HTMLElement {
9
+ constructor() {
10
+ super(...arguments);
11
+ this.inZenMode = false;
12
+ }
13
+ deactivateZenMode() {
14
+ this.inZenMode = false;
15
+ this.button.setAttribute('aria-pressed', 'false');
16
+ if (document.exitFullscreen) {
17
+ void document.exitFullscreen();
18
+ }
19
+ }
20
+ activateZenMode() {
21
+ this.inZenMode = true;
22
+ this.button.setAttribute('aria-pressed', 'true');
23
+ if (document.documentElement.requestFullscreen) {
24
+ void document.documentElement.requestFullscreen();
25
+ }
26
+ }
27
+ performAction() {
28
+ if (this.inZenMode) {
29
+ this.deactivateZenMode();
30
+ }
31
+ else {
32
+ this.activateZenMode();
33
+ }
34
+ }
35
+ };
36
+ __decorate([
37
+ target
38
+ ], ZenModeButtonElement.prototype, "button", void 0);
39
+ ZenModeButtonElement = __decorate([
40
+ controller
41
+ ], ZenModeButtonElement);
42
+ if (!window.customElements.get('zen-mode-button')) {
43
+ window.ZenModeButtonElement = ZenModeButtonElement;
44
+ window.customElements.define('zen-mode-button', ZenModeButtonElement);
45
+ }
@@ -23,3 +23,4 @@ import '../../../lib/primer/forms/primer_text_field';
23
23
  import '../../../lib/primer/forms/toggle_switch_input';
24
24
  import './alpha/action_menu/action_menu_element';
25
25
  import './open_project/page_header_element';
26
+ import './open_project/zen_mode_button';
@@ -23,3 +23,4 @@ import '../../../lib/primer/forms/primer_text_field';
23
23
  import '../../../lib/primer/forms/toggle_switch_input';
24
24
  import './alpha/action_menu/action_menu_element';
25
25
  import './open_project/page_header_element';
26
+ import './open_project/zen_mode_button';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openproject/primer-view-components",
3
- "version": "0.27.0-rc.ed6bcf82",
3
+ "version": "0.28.0-rc.6db1fc3c",
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",
@@ -4974,12 +4974,34 @@
4974
4974
  ]
4975
4975
  },
4976
4976
  {
4977
- "component": "OpenProject::PageHeader::PageHeaderActionMenu",
4977
+ "component": "OpenProject::PageHeader::Dialog",
4978
4978
  "status": "open_project",
4979
4979
  "a11y_reviewed": false,
4980
- "short_name": "OpenProjectPageHeaderPageHeaderActionMenu",
4981
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/page_header_action_menu.rb",
4982
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/page_header_action_menu/default/",
4980
+ "short_name": "OpenProjectPageHeaderDialog",
4981
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/dialog.rb",
4982
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/dialog/default/",
4983
+ "parameters": [
4984
+ {
4985
+ "name": "dialog_arguments",
4986
+ "type": "Hash",
4987
+ "default": "`{}`",
4988
+ "description": "The arguments accepted by [Dialog](/components/alpha/dialog)."
4989
+ },
4990
+ {
4991
+ "name": "button_arguments",
4992
+ "type": "Hash",
4993
+ "default": "`{}`",
4994
+ "description": "The arguments accepted by [Button](/components/beta/button) or [IconButton](/components/beta/iconbutton), depending on the value of the `icon:` argument."
4995
+ }
4996
+ ]
4997
+ },
4998
+ {
4999
+ "component": "OpenProject::PageHeader::Menu",
5000
+ "status": "open_project",
5001
+ "a11y_reviewed": false,
5002
+ "short_name": "OpenProjectPageHeaderMenu",
5003
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/menu.rb",
5004
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/menu/default/",
4983
5005
  "parameters": [
4984
5006
  {
4985
5007
  "name": "menu_arguments",
@@ -4995,6 +5017,22 @@
4995
5017
  }
4996
5018
  ]
4997
5019
  },
5020
+ {
5021
+ "component": "OpenProject::ZenModeButton",
5022
+ "status": "open_project",
5023
+ "a11y_reviewed": false,
5024
+ "short_name": "OpenProjectZenModeButton",
5025
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/zen_mode_button.rb",
5026
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/zen_mode_button/default/",
5027
+ "parameters": [
5028
+ {
5029
+ "name": "system_arguments",
5030
+ "type": "Hash",
5031
+ "default": "N/A",
5032
+ "description": "[System arguments](/system-arguments)"
5033
+ }
5034
+ ]
5035
+ },
4998
5036
  {
4999
5037
  "component": "Tooltip",
5000
5038
  "status": "deprecated",
@@ -121,7 +121,9 @@
121
121
  "Primer::OpenProject::GridLayout::Area": "",
122
122
  "Primer::OpenProject::InputGroup": "",
123
123
  "Primer::OpenProject::PageHeader": "",
124
- "Primer::OpenProject::PageHeader::PageHeaderActionMenu": "",
124
+ "Primer::OpenProject::PageHeader::Dialog": "",
125
+ "Primer::OpenProject::PageHeader::Menu": "",
126
+ "Primer::OpenProject::ZenModeButton": "",
125
127
  "Primer::Tooltip": "",
126
128
  "Primer::Truncate": ""
127
129
  }
@@ -1449,6 +1449,7 @@
1449
1449
  "block",
1450
1450
  "none"
1451
1451
  ],
1452
+ "Dialog": "Primer::OpenProject::PageHeader::Dialog",
1452
1453
  "HEADER_VARIANT_OPTIONS": [
1453
1454
  "medium",
1454
1455
  "large"
@@ -1466,9 +1467,15 @@
1466
1467
  "flex",
1467
1468
  "none"
1468
1469
  ],
1469
- "PageHeaderActionMenu": "Primer::OpenProject::PageHeader::PageHeaderActionMenu"
1470
+ "Menu": "Primer::OpenProject::PageHeader::Menu"
1470
1471
  },
1471
- "Primer::OpenProject::PageHeader::PageHeaderActionMenu": {
1472
+ "Primer::OpenProject::PageHeader::Dialog": {
1473
+ },
1474
+ "Primer::OpenProject::PageHeader::Menu": {
1475
+ },
1476
+ "Primer::OpenProject::ZenModeButton": {
1477
+ "ZEN_MODE_BUTTON_ICON": "screen-full",
1478
+ "ZEN_MODE_BUTTON_LABEL": "Translation missing: en.label_zen_mode"
1472
1479
  },
1473
1480
  "Primer::Tooltip": {
1474
1481
  "ALIGN_DEFAULT": "default",
@@ -16605,6 +16605,45 @@
16605
16605
  ]
16606
16606
  }
16607
16607
  },
16608
+ {
16609
+ "preview_path": "primer/open_project/page_header/menu_actions",
16610
+ "name": "menu_actions",
16611
+ "snapshot": "false",
16612
+ "skip_rules": {
16613
+ "wont_fix": [
16614
+ "region"
16615
+ ],
16616
+ "will_fix": [
16617
+ "color-contrast"
16618
+ ]
16619
+ }
16620
+ },
16621
+ {
16622
+ "preview_path": "primer/open_project/page_header/dialog_actions",
16623
+ "name": "dialog_actions",
16624
+ "snapshot": "false",
16625
+ "skip_rules": {
16626
+ "wont_fix": [
16627
+ "region"
16628
+ ],
16629
+ "will_fix": [
16630
+ "color-contrast"
16631
+ ]
16632
+ }
16633
+ },
16634
+ {
16635
+ "preview_path": "primer/open_project/page_header/zen_mode_button_actions",
16636
+ "name": "zen_mode_button_actions",
16637
+ "snapshot": "false",
16638
+ "skip_rules": {
16639
+ "wont_fix": [
16640
+ "region"
16641
+ ],
16642
+ "will_fix": [
16643
+ "color-contrast"
16644
+ ]
16645
+ }
16646
+ },
16608
16647
  {
16609
16648
  "preview_path": "primer/open_project/page_header/leading_action",
16610
16649
  "name": "leading_action",
@@ -16637,18 +16676,58 @@
16637
16676
  ]
16638
16677
  },
16639
16678
  {
16640
- "fully_qualified_name": "Primer::OpenProject::PageHeader::PageHeaderActionMenu",
16641
- "description": "A Helper class to create ActionMenus inside the PageHeader action slot",
16679
+ "fully_qualified_name": "Primer::OpenProject::PageHeader::Dialog",
16680
+ "description": "A Helper class to create ActionMenus inside the PageHeader action slot\nDo not use standalone",
16642
16681
  "accessibility_docs": null,
16643
16682
  "is_form_component": false,
16644
16683
  "is_published": true,
16645
16684
  "requires_js": false,
16646
- "component": "OpenProject::PageHeader::PageHeaderActionMenu",
16685
+ "component": "OpenProject::PageHeader::Dialog",
16647
16686
  "status": "open_project",
16648
16687
  "a11y_reviewed": false,
16649
- "short_name": "OpenProjectPageHeaderPageHeaderActionMenu",
16650
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/page_header_action_menu.rb",
16651
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/page_header_action_menu/default/",
16688
+ "short_name": "OpenProjectPageHeaderDialog",
16689
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/dialog.rb",
16690
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/dialog/default/",
16691
+ "parameters": [
16692
+ {
16693
+ "name": "dialog_arguments",
16694
+ "type": "Hash",
16695
+ "default": "`{}`",
16696
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}."
16697
+ },
16698
+ {
16699
+ "name": "button_arguments",
16700
+ "type": "Hash",
16701
+ "default": "`{}`",
16702
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} or {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}, depending on the value of the `icon:` argument."
16703
+ }
16704
+ ],
16705
+ "slots": [
16706
+
16707
+ ],
16708
+ "methods": [
16709
+
16710
+ ],
16711
+ "previews": [
16712
+
16713
+ ],
16714
+ "subcomponents": [
16715
+
16716
+ ]
16717
+ },
16718
+ {
16719
+ "fully_qualified_name": "Primer::OpenProject::PageHeader::Menu",
16720
+ "description": "A Helper class to create ActionMenus inside the PageHeader action slot\nIt should not be used standalone",
16721
+ "accessibility_docs": null,
16722
+ "is_form_component": false,
16723
+ "is_published": true,
16724
+ "requires_js": false,
16725
+ "component": "OpenProject::PageHeader::Menu",
16726
+ "status": "open_project",
16727
+ "a11y_reviewed": false,
16728
+ "short_name": "OpenProjectPageHeaderMenu",
16729
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/page_header/menu.rb",
16730
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/page_header/menu/default/",
16652
16731
  "parameters": [
16653
16732
  {
16654
16733
  "name": "menu_arguments",
@@ -16676,6 +16755,65 @@
16676
16755
 
16677
16756
  ]
16678
16757
  },
16758
+ {
16759
+ "fully_qualified_name": "Primer::OpenProject::ZenModeButton",
16760
+ "description": "Add a general description of component here\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
16761
+ "accessibility_docs": "Add any accessibility considerations",
16762
+ "is_form_component": false,
16763
+ "is_published": true,
16764
+ "requires_js": false,
16765
+ "component": "OpenProject::ZenModeButton",
16766
+ "status": "open_project",
16767
+ "a11y_reviewed": false,
16768
+ "short_name": "OpenProjectZenModeButton",
16769
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/zen_mode_button.rb",
16770
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/zen_mode_button/default/",
16771
+ "parameters": [
16772
+ {
16773
+ "name": "system_arguments",
16774
+ "type": "Hash",
16775
+ "default": "N/A",
16776
+ "description": "{{link_to_system_arguments_docs}}"
16777
+ }
16778
+ ],
16779
+ "slots": [
16780
+
16781
+ ],
16782
+ "methods": [
16783
+
16784
+ ],
16785
+ "previews": [
16786
+ {
16787
+ "preview_path": "primer/open_project/zen_mode_button/default",
16788
+ "name": "default",
16789
+ "snapshot": "true",
16790
+ "skip_rules": {
16791
+ "wont_fix": [
16792
+ "region"
16793
+ ],
16794
+ "will_fix": [
16795
+ "color-contrast"
16796
+ ]
16797
+ }
16798
+ },
16799
+ {
16800
+ "preview_path": "primer/open_project/zen_mode_button/playground",
16801
+ "name": "playground",
16802
+ "snapshot": "false",
16803
+ "skip_rules": {
16804
+ "wont_fix": [
16805
+ "region"
16806
+ ],
16807
+ "will_fix": [
16808
+ "color-contrast"
16809
+ ]
16810
+ }
16811
+ }
16812
+ ],
16813
+ "subcomponents": [
16814
+
16815
+ ]
16816
+ },
16679
16817
  {
16680
16818
  "fully_qualified_name": "Primer::Tooltip",
16681
16819
  "description": "`Tooltip` is a wrapper component that will apply a tooltip to the provided content.",
@@ -5196,6 +5196,45 @@
5196
5196
  ]
5197
5197
  }
5198
5198
  },
5199
+ {
5200
+ "preview_path": "primer/open_project/page_header/menu_actions",
5201
+ "name": "menu_actions",
5202
+ "snapshot": "false",
5203
+ "skip_rules": {
5204
+ "wont_fix": [
5205
+ "region"
5206
+ ],
5207
+ "will_fix": [
5208
+ "color-contrast"
5209
+ ]
5210
+ }
5211
+ },
5212
+ {
5213
+ "preview_path": "primer/open_project/page_header/dialog_actions",
5214
+ "name": "dialog_actions",
5215
+ "snapshot": "false",
5216
+ "skip_rules": {
5217
+ "wont_fix": [
5218
+ "region"
5219
+ ],
5220
+ "will_fix": [
5221
+ "color-contrast"
5222
+ ]
5223
+ }
5224
+ },
5225
+ {
5226
+ "preview_path": "primer/open_project/page_header/zen_mode_button_actions",
5227
+ "name": "zen_mode_button_actions",
5228
+ "snapshot": "false",
5229
+ "skip_rules": {
5230
+ "wont_fix": [
5231
+ "region"
5232
+ ],
5233
+ "will_fix": [
5234
+ "color-contrast"
5235
+ ]
5236
+ }
5237
+ },
5199
5238
  {
5200
5239
  "preview_path": "primer/open_project/page_header/leading_action",
5201
5240
  "name": "leading_action",
@@ -7456,5 +7495,39 @@
7456
7495
  }
7457
7496
  }
7458
7497
  ]
7498
+ },
7499
+ {
7500
+ "name": "zen_mode_button",
7501
+ "component": "OpenProject::ZenModeButton",
7502
+ "status": "open_project",
7503
+ "lookup_path": "primer/open_project/zen_mode_button",
7504
+ "examples": [
7505
+ {
7506
+ "preview_path": "primer/open_project/zen_mode_button/default",
7507
+ "name": "default",
7508
+ "snapshot": "true",
7509
+ "skip_rules": {
7510
+ "wont_fix": [
7511
+ "region"
7512
+ ],
7513
+ "will_fix": [
7514
+ "color-contrast"
7515
+ ]
7516
+ }
7517
+ },
7518
+ {
7519
+ "preview_path": "primer/open_project/zen_mode_button/playground",
7520
+ "name": "playground",
7521
+ "snapshot": "false",
7522
+ "skip_rules": {
7523
+ "wont_fix": [
7524
+ "region"
7525
+ ],
7526
+ "will_fix": [
7527
+ "color-contrast"
7528
+ ]
7529
+ }
7530
+ }
7531
+ ]
7459
7532
  }
7460
7533
  ]
@@ -121,7 +121,9 @@
121
121
  "Primer::OpenProject::GridLayout::Area": "open_project",
122
122
  "Primer::OpenProject::InputGroup": "open_project",
123
123
  "Primer::OpenProject::PageHeader": "open_project",
124
- "Primer::OpenProject::PageHeader::PageHeaderActionMenu": "open_project",
124
+ "Primer::OpenProject::PageHeader::Dialog": "open_project",
125
+ "Primer::OpenProject::PageHeader::Menu": "open_project",
126
+ "Primer::OpenProject::ZenModeButton": "open_project",
125
127
  "Primer::Tooltip": "deprecated",
126
128
  "Primer::Truncate": "deprecated"
127
129
  }