openproject-primer_view_components 0.11.0 → 0.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +110 -0
- data/app/assets/javascripts/app/components/primer/alpha/tool_tip.d.ts +1 -0
- data/app/assets/javascripts/app/components/primer/primer.d.ts +1 -1
- data/app/assets/javascripts/primer_view_components.js +1 -1
- data/app/assets/javascripts/primer_view_components.js.map +1 -1
- data/app/assets/styles/primer_view_components.css +1 -1
- data/app/assets/styles/primer_view_components.css.map +1 -1
- data/app/components/primer/alpha/action_bar/item.rb +7 -4
- data/app/components/primer/alpha/action_bar.rb +2 -2
- data/app/components/primer/alpha/action_bar_element.js +9 -4
- data/app/components/primer/alpha/action_bar_element.ts +9 -2
- data/app/components/primer/alpha/action_list/form_wrapper.html.erb +4 -2
- data/app/components/primer/alpha/action_list/form_wrapper.rb +20 -9
- data/app/components/primer/alpha/action_menu/action_menu_element.js +162 -86
- data/app/components/primer/alpha/action_menu/action_menu_element.ts +197 -82
- data/app/components/primer/alpha/action_menu/list.rb +0 -2
- data/app/components/primer/alpha/action_menu.rb +120 -3
- data/app/components/primer/alpha/check_box_group.rb +2 -0
- data/app/components/primer/alpha/dialog/header.rb +12 -0
- data/app/components/primer/alpha/dialog.rb +1 -1
- data/app/components/primer/alpha/modal_dialog.js +10 -13
- data/app/components/primer/alpha/modal_dialog.ts +10 -13
- data/app/components/primer/alpha/nav_list/divider.rb +2 -5
- data/app/components/primer/alpha/nav_list/group.rb +2 -98
- data/app/components/primer/alpha/nav_list/heading.rb +2 -27
- data/app/components/primer/alpha/nav_list/item.rb +2 -147
- data/app/components/primer/alpha/nav_list.rb +2 -205
- data/app/components/primer/alpha/overlay.css +1 -1
- data/app/components/primer/alpha/overlay.css.map +1 -1
- data/app/components/primer/alpha/overlay.pcss +1 -7
- data/app/components/primer/alpha/overlay.rb +6 -4
- data/app/components/primer/alpha/radio_button_group.rb +2 -0
- data/app/components/primer/alpha/segmented_control/item.html.erb +1 -8
- data/app/components/primer/alpha/segmented_control/item.rb +38 -4
- data/app/components/primer/alpha/segmented_control.css +1 -1
- data/app/components/primer/alpha/segmented_control.css.json +14 -13
- data/app/components/primer/alpha/segmented_control.css.map +1 -1
- data/app/components/primer/alpha/segmented_control.pcss +75 -66
- data/app/components/primer/alpha/segmented_control.rb +10 -0
- data/app/components/primer/alpha/text_field.css +1 -1
- data/app/components/primer/alpha/text_field.css.json +4 -1
- data/app/components/primer/alpha/text_field.css.map +1 -1
- data/app/components/primer/alpha/text_field.pcss +18 -3
- data/app/components/primer/alpha/tool_tip.d.ts +1 -0
- data/app/components/primer/alpha/tool_tip.js +26 -93
- data/app/components/primer/alpha/tool_tip.ts +25 -91
- data/app/components/primer/alpha/tooltip.rb +3 -1
- data/app/components/primer/beta/base_button.rb +4 -0
- data/app/components/primer/beta/button.css +1 -1
- data/app/components/primer/beta/button.css.json +2 -0
- data/app/components/primer/beta/button.css.map +1 -1
- data/app/components/primer/beta/button.pcss +17 -5
- data/app/components/primer/beta/icon_button.html.erb +1 -1
- data/app/components/primer/beta/icon_button.rb +8 -1
- data/app/components/primer/beta/link.css +1 -1
- data/app/components/primer/beta/link.css.json +1 -0
- data/app/components/primer/beta/link.css.map +1 -1
- data/app/components/primer/beta/link.pcss +5 -0
- data/app/components/primer/beta/link.rb +2 -2
- data/app/components/primer/beta/nav_list/divider.rb +14 -0
- data/app/components/primer/beta/nav_list/group.rb +107 -0
- data/app/components/primer/beta/nav_list/heading.rb +36 -0
- data/app/components/primer/beta/nav_list/item.rb +156 -0
- data/app/components/primer/beta/nav_list.rb +212 -0
- data/app/components/primer/focus_group.js +30 -4
- data/app/components/primer/focus_group.ts +29 -2
- data/app/components/primer/open_project/flex_layout.html.erb +23 -0
- data/app/components/primer/open_project/flex_layout.rb +52 -0
- data/app/components/primer/open_project/grid_layout/area.rb +38 -0
- data/app/components/primer/open_project/grid_layout.html.erb +11 -0
- data/app/components/primer/open_project/grid_layout.rb +34 -0
- data/app/components/primer/open_project/page_header.css +1 -1
- data/app/components/primer/open_project/page_header.css.map +1 -1
- data/app/components/primer/open_project/page_header.pcss +4 -0
- data/app/components/primer/primer.d.ts +1 -1
- data/app/components/primer/primer.js +1 -1
- data/app/components/primer/primer.ts +1 -1
- data/app/helpers/primer/form_helper.rb +10 -0
- data/lib/primer/accessibility.rb +3 -1
- data/lib/primer/deprecations.yml +20 -0
- data/lib/primer/forms/check_box_group.html.erb +3 -0
- data/lib/primer/forms/dsl/check_box_group_input.rb +1 -5
- data/lib/primer/forms/dsl/check_box_input.rb +5 -0
- data/lib/primer/forms/dsl/radio_button_input.rb +5 -0
- data/lib/primer/forms/form_control.html.erb +1 -4
- data/lib/primer/forms/radio_button_group.html.erb +3 -0
- data/lib/primer/forms/utils.rb +2 -0
- data/lib/primer/forms/validation_message.html.erb +4 -0
- data/lib/primer/forms/validation_message.rb +14 -0
- data/lib/primer/forms.rb +16 -0
- data/lib/primer/static/generate_info_arch.rb +86 -5
- data/lib/primer/view_components/version.rb +1 -1
- data/lib/primer/yard/component_manifest.rb +4 -0
- data/previews/primer/alpha/action_menu_preview/single_select_form_items.html.erb +31 -0
- data/previews/primer/alpha/action_menu_preview/with_actions.html.erb +6 -5
- data/previews/primer/alpha/action_menu_preview.rb +10 -1
- data/previews/primer/alpha/check_box_group_preview.rb +13 -0
- data/previews/primer/alpha/check_box_preview.rb +1 -0
- data/previews/primer/alpha/dialog_preview/autofocus_element.html.erb +8 -0
- data/previews/primer/alpha/dialog_preview/with_header.html.erb +5 -0
- data/previews/primer/alpha/dialog_preview.rb +22 -0
- data/previews/primer/alpha/overlay_preview.rb +1 -1
- data/previews/primer/alpha/radio_button_group_preview.rb +13 -0
- data/previews/primer/alpha/radio_button_preview.rb +2 -1
- data/previews/primer/alpha/segmented_control_preview.rb +35 -0
- data/previews/primer/alpha/text_field_preview/input_group_leading_action_menu.html.erb +21 -0
- data/previews/primer/alpha/text_field_preview/input_group_leading_button.html.erb +18 -0
- data/previews/primer/alpha/text_field_preview/input_group_trailing_button.html.erb +18 -0
- data/previews/primer/alpha/text_field_preview.rb +21 -0
- data/previews/primer/alpha/tooltip_preview/tooltip_with_dialog_moving_focus_to_input.html.erb +23 -0
- data/previews/primer/alpha/tooltip_preview.rb +6 -1
- data/previews/primer/beta/button_group_preview.rb +6 -6
- data/previews/primer/beta/button_preview.rb +21 -3
- data/previews/primer/beta/icon_button_preview.rb +3 -0
- data/previews/primer/{alpha → beta}/nav_list_preview/trailing_action.html.erb +1 -1
- data/previews/primer/{alpha → beta}/nav_list_preview.rb +5 -5
- data/previews/primer/open_project/flex_layout_preview.rb +73 -0
- data/previews/primer/open_project/grid_layout_preview.rb +37 -0
- data/static/arguments.json +278 -7
- data/static/audited_at.json +8 -0
- data/static/classes.json +15 -0
- data/static/constants.json +47 -1
- data/static/info_arch.json +1338 -632
- data/static/previews.json +271 -167
- data/static/statuses.json +13 -5
- metadata +33 -319
- /data/app/assets/javascripts/app/components/primer/{alpha → beta}/nav_list.d.ts +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list/group.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list/item.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.d.ts +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.js +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.ts +0 -0
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["link.pcss"],"names":[],"mappings":"AAEA,MACE,
|
1
|
+
{"version":3,"sources":["link.pcss"],"names":[],"mappings":"AAEA,MACE,kDAA4B,CAC5B,oBAeF,CAbE,YAEE,cACF,CAEA,wBAJE,yBAMF,CAEA,gCAEE,gBACF,CAGF,iBACE,yBACF,CAEA,eACE,8DAKF,CAHE,qBACE,4DACF,CAGF,iBACE,0DAKF,CAHE,uBACE,4DACF,CAGF,aACE,0DAMF,CAJE,mBAEE,oBACF,CAMA,wCARE,4DAYF,CAJA,qBAGE,cAAe,CADf,yBAEF,CAQA,qHACE,uBACF","file":"link.css","sourcesContent":["/* Links */\n\n.Link {\n color: var(--fgColor-accent);\n text-decoration: none;\n\n &:hover {\n text-decoration: underline;\n cursor: pointer;\n }\n\n &:focus {\n text-decoration: underline;\n }\n\n &:focus,\n &:focus-visible {\n outline-offset: 0;\n }\n}\n\n.Link--underline {\n text-decoration: underline;\n}\n\n.Link--primary {\n color: var(--fgColor-default) !important;\n\n &:hover {\n color: var(--fgColor-accent) !important;\n }\n}\n\n.Link--secondary {\n color: var(--fgColor-muted) !important;\n\n &:hover {\n color: var(--fgColor-accent) !important;\n }\n}\n\n.Link--muted {\n color: var(--fgColor-muted) !important;\n\n &:hover {\n color: var(--fgColor-accent) !important;\n text-decoration: none;\n }\n}\n\n/* Set the link color only on hover\n Useful when you want only part of a link to turn blue on hover */\n.Link--onHover {\n &:hover {\n color: var(--fgColor-accent) !important;\n text-decoration: underline;\n cursor: pointer;\n }\n}\n\n/* When using a color utility class inside of a link class\n color should change with link on hover. */\n.Link--secondary,\n.Link--primary,\n.Link--muted {\n &:hover [class*='color-fg'] {\n color: inherit !important;\n }\n}\n"]}
|
@@ -2,6 +2,7 @@
|
|
2
2
|
|
3
3
|
.Link {
|
4
4
|
color: var(--fgColor-accent);
|
5
|
+
text-decoration: none;
|
5
6
|
|
6
7
|
&:hover {
|
7
8
|
text-decoration: underline;
|
@@ -18,6 +19,10 @@
|
|
18
19
|
}
|
19
20
|
}
|
20
21
|
|
22
|
+
.Link--underline {
|
23
|
+
text-decoration: underline;
|
24
|
+
}
|
25
|
+
|
21
26
|
.Link--primary {
|
22
27
|
color: var(--fgColor-default) !important;
|
23
28
|
|
@@ -35,7 +35,7 @@ module Primer
|
|
35
35
|
# @param muted [Boolean] Uses light gray for Link color, and blue on hover.
|
36
36
|
# @param underline [Boolean] Whether or not to underline the link.
|
37
37
|
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
|
38
|
-
def initialize(href: nil, scheme: DEFAULT_SCHEME, muted: false, underline:
|
38
|
+
def initialize(href: nil, scheme: DEFAULT_SCHEME, muted: false, underline: false, **system_arguments)
|
39
39
|
@system_arguments = deny_tag_argument(**system_arguments)
|
40
40
|
|
41
41
|
@id = @system_arguments[:id]
|
@@ -47,7 +47,7 @@ module Primer
|
|
47
47
|
SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_MAPPINGS.keys, scheme, DEFAULT_SCHEME)],
|
48
48
|
"Link",
|
49
49
|
"Link--muted" => muted,
|
50
|
-
"
|
50
|
+
"Link--underline" => underline
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Primer
|
4
|
+
module Beta
|
5
|
+
class NavList
|
6
|
+
# Separator with optional text rendered above groups or between individual items.
|
7
|
+
class Divider < Primer::Alpha::ActionList::Divider
|
8
|
+
def kind
|
9
|
+
:divider
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,107 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Primer
|
4
|
+
module Beta
|
5
|
+
class NavList
|
6
|
+
# A logical grouping of navigation links with an optional heading.
|
7
|
+
#
|
8
|
+
# See <%= link_to_component(Primer::Beta::NavList) %> for usage examples.
|
9
|
+
class Group < Primer::Alpha::ActionList
|
10
|
+
# A special "show more" list item that appears at the bottom of the group. Clicking
|
11
|
+
# the item will fetch the next page of results from the URL passed in the `src` argument
|
12
|
+
# and append the resulting chunk of HTML to the group.
|
13
|
+
#
|
14
|
+
# @param src [String] The URL to query for additional pages of list items.
|
15
|
+
# @param pages [Integer] The total number of pages in the result set.
|
16
|
+
# @param component_klass [Class] A component class to use instead of the default `Primer::Beta::NavList::Item` class.
|
17
|
+
# @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::NavList::Item) %>.
|
18
|
+
renders_one :show_more_item, lambda { |src:, pages:, component_klass: NavList::Item, **system_arguments|
|
19
|
+
system_arguments[:classes] = class_names(
|
20
|
+
@item_classes,
|
21
|
+
system_arguments[:classes]
|
22
|
+
)
|
23
|
+
system_arguments[:tag] = :div
|
24
|
+
system_arguments[:id] ||= self.class.generate_id(base_name: "item")
|
25
|
+
system_arguments[:hidden] = true
|
26
|
+
system_arguments[:href] = "#"
|
27
|
+
system_arguments[:data] ||= {}
|
28
|
+
system_arguments[:data][:target] = "nav-list.showMoreItem"
|
29
|
+
system_arguments[:data][:action] = "click:nav-list#showMore"
|
30
|
+
system_arguments[:data][:current_page] = "1"
|
31
|
+
system_arguments[:data][:total_pages] = pages.to_s
|
32
|
+
system_arguments[:label_arguments] = {
|
33
|
+
**system_arguments[:label_arguments] || {},
|
34
|
+
color: :accent
|
35
|
+
}
|
36
|
+
|
37
|
+
system_arguments[:content_arguments] = {
|
38
|
+
**system_arguments[:content_arguments] || {},
|
39
|
+
tag: :button
|
40
|
+
}
|
41
|
+
|
42
|
+
system_arguments[:content_arguments][:data] = merge_data(
|
43
|
+
system_arguments[:content_arguments],
|
44
|
+
data: { list_id: id }
|
45
|
+
)
|
46
|
+
|
47
|
+
component_klass.new(list: self, src: src, **system_arguments)
|
48
|
+
}
|
49
|
+
|
50
|
+
# @private
|
51
|
+
def self.custom_element_name
|
52
|
+
Primer::Beta::NavList.custom_element_name
|
53
|
+
end
|
54
|
+
|
55
|
+
# @param selected_item_id [Symbol] The ID of the currently selected item. Used internally.
|
56
|
+
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
|
57
|
+
def initialize(selected_item_id: nil, **system_arguments)
|
58
|
+
@system_arguments = system_arguments
|
59
|
+
@selected_item_id = selected_item_id
|
60
|
+
|
61
|
+
super(**@system_arguments)
|
62
|
+
end
|
63
|
+
|
64
|
+
# Cause this group to show its list of sub items when rendered.
|
65
|
+
# :nocov:
|
66
|
+
def expand!
|
67
|
+
@expanded = true
|
68
|
+
end
|
69
|
+
# :nocov:
|
70
|
+
|
71
|
+
# @!parse
|
72
|
+
# # Items.
|
73
|
+
# #
|
74
|
+
# # @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::NavList::Item) %>.
|
75
|
+
# renders_many :items
|
76
|
+
|
77
|
+
# @private
|
78
|
+
def build_item(component_klass: NavList::Item, **system_arguments)
|
79
|
+
super(
|
80
|
+
component_klass: component_klass,
|
81
|
+
selected_item_id: @selected_item_id,
|
82
|
+
**system_arguments
|
83
|
+
)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @private
|
87
|
+
def build_avatar_item(component_klass: NavList::Item, **system_arguments)
|
88
|
+
super(
|
89
|
+
component_klass: component_klass,
|
90
|
+
selected_item_id: @selected_item_id,
|
91
|
+
**system_arguments
|
92
|
+
)
|
93
|
+
end
|
94
|
+
|
95
|
+
def kind
|
96
|
+
:group
|
97
|
+
end
|
98
|
+
|
99
|
+
def before_render
|
100
|
+
super
|
101
|
+
|
102
|
+
raise ArgumentError, "NavList groups are required to have headings" unless heading?
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Primer
|
4
|
+
module Beta
|
5
|
+
class NavList
|
6
|
+
# The heading placed above a `NavList`'s items.
|
7
|
+
#
|
8
|
+
# See <%= link_to_component(Primer::Beta::NavList) %> for usage examples.
|
9
|
+
class Heading < Primer::Component
|
10
|
+
attr_reader :title, :id, :heading_level, :system_arguments
|
11
|
+
|
12
|
+
# @param title [String] The text content of the heading.
|
13
|
+
# @param id [String] The value of the ID HTML attribute. Auto-generated by default.
|
14
|
+
# @param heading_level [Integer] The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc.
|
15
|
+
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
|
16
|
+
def initialize(title:, id: self.class.generate_id, heading_level: 2, **system_arguments)
|
17
|
+
@title = title
|
18
|
+
@id = id
|
19
|
+
@heading_level = heading_level
|
20
|
+
@system_arguments = system_arguments
|
21
|
+
end
|
22
|
+
|
23
|
+
def call
|
24
|
+
render(
|
25
|
+
Primer::BaseComponent.new(
|
26
|
+
tag: :"h#{heading_level}",
|
27
|
+
id: id,
|
28
|
+
classes: "ActionListHeader",
|
29
|
+
**system_arguments
|
30
|
+
).with_content(title)
|
31
|
+
)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,156 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Primer
|
4
|
+
module Beta
|
5
|
+
class NavList
|
6
|
+
# Items are rendered as styled links. They can optionally include leading and/or trailing visuals,
|
7
|
+
# such as icons, avatars, and counters. Items are selected by ID. IDs can be specified via the
|
8
|
+
# `selected_item_ids` argument, which accepts a list of valid IDs for the item. Items can also
|
9
|
+
# themselves contain sub items. Sub items are rendered collapsed by default.
|
10
|
+
class Item < Primer::Alpha::ActionList::Item
|
11
|
+
attr_reader :selected_by_ids, :sub_item
|
12
|
+
|
13
|
+
# @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Alpha::ActionList::Item) %>.
|
14
|
+
renders_many :items, lambda { |**system_arguments|
|
15
|
+
raise "Items can only be nested 2 levels deep" if sub_item?
|
16
|
+
|
17
|
+
@list.build_item(parent: self, sub_item: true, **system_arguments).tap do |item|
|
18
|
+
@list.will_add_item(item)
|
19
|
+
end
|
20
|
+
}
|
21
|
+
|
22
|
+
# Whether or not this item is nested under a parent item.
|
23
|
+
#
|
24
|
+
# @return [Boolean]
|
25
|
+
alias sub_item? sub_item
|
26
|
+
|
27
|
+
# @param selected_item_id [Symbol] The ID of the currently selected list item. Used internally.
|
28
|
+
# @param selected_by_ids [Array<Symbol>] The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected.
|
29
|
+
# @param expanded [Boolean] Whether this item shows (expands) or hides (collapses) its list of sub items.
|
30
|
+
# @param sub_item [Boolean] Whether or not this item is nested under a parent item. Used internally.
|
31
|
+
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
|
32
|
+
def initialize(selected_item_id: nil, selected_by_ids: [], sub_item: false, expanded: false, **system_arguments)
|
33
|
+
@selected_item_id = selected_item_id
|
34
|
+
@selected_by_ids = Array(selected_by_ids)
|
35
|
+
@expanded = expanded
|
36
|
+
@sub_item = sub_item
|
37
|
+
|
38
|
+
system_arguments[:classes] = class_names(
|
39
|
+
system_arguments[:classes],
|
40
|
+
"ActionListItem--subItem" => @sub_item
|
41
|
+
)
|
42
|
+
|
43
|
+
@sub_list_arguments = {
|
44
|
+
classes: class_names(
|
45
|
+
"ActionList",
|
46
|
+
"ActionList--subGroup"
|
47
|
+
)
|
48
|
+
}
|
49
|
+
|
50
|
+
@list = system_arguments[:list]
|
51
|
+
|
52
|
+
@sub_list_arguments["data-action"] = "keydown:#{@list.custom_element_name}#handleItemWithSubItemKeydown" if @list
|
53
|
+
|
54
|
+
overrides = { "data-item-id": @selected_by_ids.join(" ") }
|
55
|
+
|
56
|
+
super(**system_arguments, **overrides)
|
57
|
+
end
|
58
|
+
|
59
|
+
def active?
|
60
|
+
item_active?(self) && items.empty?
|
61
|
+
end
|
62
|
+
|
63
|
+
# Cause this item to show its list of sub items when rendered.
|
64
|
+
def expand!
|
65
|
+
@expanded = true
|
66
|
+
end
|
67
|
+
|
68
|
+
def before_render
|
69
|
+
if active_sub_item?
|
70
|
+
expand!
|
71
|
+
|
72
|
+
@content_arguments[:classes] = class_names(
|
73
|
+
@content_arguments[:classes],
|
74
|
+
"ActionListContent--hasActiveSubItem"
|
75
|
+
)
|
76
|
+
else
|
77
|
+
@system_arguments[:classes] = class_names(
|
78
|
+
@system_arguments[:classes],
|
79
|
+
"ActionListItem--navActive" => active?
|
80
|
+
)
|
81
|
+
end
|
82
|
+
|
83
|
+
@content_arguments[:"aria-current"] = "page" if active?
|
84
|
+
|
85
|
+
super
|
86
|
+
|
87
|
+
raise "Cannot render a trailing action for an item with subitems" if items.present? && trailing_action.present?
|
88
|
+
|
89
|
+
raise "Cannot pass `selected_by_ids:` for an item with subitems, since parent items cannot be selected" if items.present? && @selected_by_ids.present?
|
90
|
+
|
91
|
+
return if items.blank?
|
92
|
+
|
93
|
+
@sub_list_arguments[:aria] = merge_aria(
|
94
|
+
@sub_list_arguments,
|
95
|
+
{ aria: { labelledby: id } }
|
96
|
+
)
|
97
|
+
|
98
|
+
raise ArgumentError, "Items with sub-items cannot have hrefs" if href.present?
|
99
|
+
|
100
|
+
@content_arguments[:tag] = :button
|
101
|
+
@content_arguments[:"aria-expanded"] = @expanded.to_s
|
102
|
+
@content_arguments[:"data-action"] = "
|
103
|
+
click:#{@list.custom_element_name}#handleItemWithSubItemClick
|
104
|
+
keydown:#{@list.custom_element_name}#handleItemWithSubItemKeydown
|
105
|
+
"
|
106
|
+
|
107
|
+
with_private_trailing_action_icon(:"chevron-down", classes: "ActionListItem-collapseIcon")
|
108
|
+
|
109
|
+
@system_arguments[:classes] = class_names(
|
110
|
+
@system_arguments[:classes],
|
111
|
+
"ActionListItem--hasSubItem"
|
112
|
+
)
|
113
|
+
end
|
114
|
+
|
115
|
+
def kind
|
116
|
+
:item
|
117
|
+
end
|
118
|
+
|
119
|
+
private
|
120
|
+
|
121
|
+
# Normally it would be easier to simply ask each item for its active status, eg.
|
122
|
+
# items.any?(&:active?), but unfortunately the view context is not set on each
|
123
|
+
# item until _after_ the parent's before_render, etc methods have been called.
|
124
|
+
# This means helper methods like current_page? will blow up with an error, since
|
125
|
+
# `helpers` is simply an alias for the view context (i.e. an instance of
|
126
|
+
# ActionView::Base). Since we know the view context for the parent object must
|
127
|
+
# be set before `before_render` is invoked, we can call helper methods here in
|
128
|
+
# the parent and bypass the problem entirely. Maybe not the most OO approach,
|
129
|
+
# but it works.
|
130
|
+
def item_active?(item)
|
131
|
+
if item.selected_by_ids.present?
|
132
|
+
item.selected_by_ids.include?(@selected_item_id)
|
133
|
+
elsif item.href
|
134
|
+
current_page?(item.href)
|
135
|
+
else
|
136
|
+
# :nocov:
|
137
|
+
false
|
138
|
+
# :nocov:
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
def active_sub_item?
|
143
|
+
items.any? { |subitem| item_active?(subitem) }
|
144
|
+
end
|
145
|
+
|
146
|
+
def current_page?(url)
|
147
|
+
helpers.current_page?(url)
|
148
|
+
end
|
149
|
+
|
150
|
+
def list_class
|
151
|
+
Primer::Beta::NavList
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
156
|
+
end
|
@@ -0,0 +1,212 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Primer
|
4
|
+
module Beta
|
5
|
+
# `NavList` provides a simple way to render side navigation, i.e. navigation
|
6
|
+
# that appears to the left or right side of some main content. Each group in a
|
7
|
+
# nav list is a list of links.
|
8
|
+
#
|
9
|
+
# Nav list groups can contain sub items. Rather than navigating to a URL, groups
|
10
|
+
# with sub items expand and collapse on click. To indicate this functionality, the
|
11
|
+
# group will automatically render with a trailing chevron icon that changes direction
|
12
|
+
# when the group expands and collapses.
|
13
|
+
#
|
14
|
+
# Nav list items appear visually active when selected. Each nav item must have one
|
15
|
+
# or more ID values that determine which item will appear selected. Use the
|
16
|
+
# `selected_item_id` argument to select the appropriate item.
|
17
|
+
class NavList < Primer::Component
|
18
|
+
status :beta
|
19
|
+
audited_at "2023-07-10"
|
20
|
+
|
21
|
+
# @private
|
22
|
+
def self.custom_element_name
|
23
|
+
"nav-list"
|
24
|
+
end
|
25
|
+
|
26
|
+
# The heading for the list at large. Accepts the arguments accepted by <%= link_to_component(Primer::Beta::NavList::Heading) %>.
|
27
|
+
#
|
28
|
+
renders_one :heading, Primer::Beta::NavList::Heading
|
29
|
+
|
30
|
+
# @!parse
|
31
|
+
# # Adds an item to the list.
|
32
|
+
# #
|
33
|
+
# # @param component_klass [Class] The class to use instead of the default <%= link_to_component(Primer::Beta::NavList::Item) %>
|
34
|
+
# # @param system_arguments [Hash] These arguments are forwarded to <%= link_to_component(Primer::Beta::NavList::Item) %>, or whatever class is passed as the `component_klass` argument.
|
35
|
+
# def with_item(component_klass: Primer::Beta::NavList::Item, **system_arguments, &block)
|
36
|
+
# end
|
37
|
+
|
38
|
+
# @!parse
|
39
|
+
# # Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.
|
40
|
+
# #
|
41
|
+
# # @param src [String] The source url of the avatar image.
|
42
|
+
# # @param username [String] The username associated with the avatar.
|
43
|
+
# # @param full_name [String] Optional. The user's full name.
|
44
|
+
# # @param full_name_scheme [Symbol] Optional. How to display the user's full name. <%= one_of(Primer::Alpha::ActionList::Item::DESCRIPTION_SCHEME_OPTIONS) %>
|
45
|
+
# # @param component_klass [Class] The class to use instead of the default <%= link_to_component(Primer::Beta::NavList::Item) %>
|
46
|
+
# # @param avatar_arguments [Hash] Optional. The arguments accepted by <%= link_to_component(Primer::Beta::Avatar) %>
|
47
|
+
# # @param system_arguments [Hash] These arguments are forwarded to <%= link_to_component(Primer::Beta::NavList::Item) %>, or whatever class is passed as the `component_klass` argument.
|
48
|
+
# def with_avatar_item(src:, username:, full_name: nil, full_name_scheme: Primer::Alpha::ActionList::Item::DEFAULT_DESCRIPTION_SCHEME, component_klass: Primer::Beta::NavList::Item, avatar_arguments: {}, **system_arguments, &block)
|
49
|
+
# end
|
50
|
+
|
51
|
+
# @!parse
|
52
|
+
# # Adds a group to the list. A group is a list of links and a (required) heading.
|
53
|
+
# #
|
54
|
+
# # @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::NavList::Group) %>.
|
55
|
+
# def with_group(**system_arguments, &block)
|
56
|
+
# end
|
57
|
+
|
58
|
+
# @!parse
|
59
|
+
# # Adds a divider to the list. Dividers visually separate items and groups.
|
60
|
+
# #
|
61
|
+
# # @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::NavList::Divider) %>.
|
62
|
+
# def with_divider(**system_arguments, &block)
|
63
|
+
# end
|
64
|
+
|
65
|
+
# Items. Items can be individual items, dividers, or groups. See the documentation for `#with_item`, `#with_divider`, and `#with_group` respectively for more information.
|
66
|
+
#
|
67
|
+
renders_many :items, types: {
|
68
|
+
item: {
|
69
|
+
renders: lambda { |**system_arguments, &block|
|
70
|
+
build_item(**system_arguments, &block)
|
71
|
+
},
|
72
|
+
|
73
|
+
as: :item
|
74
|
+
},
|
75
|
+
|
76
|
+
avatar_item: {
|
77
|
+
renders: lambda { |**system_arguments|
|
78
|
+
build_avatar_item(**system_arguments)
|
79
|
+
},
|
80
|
+
|
81
|
+
as: :avatar_item
|
82
|
+
},
|
83
|
+
|
84
|
+
divider: {
|
85
|
+
renders: Primer::Beta::NavList::Divider,
|
86
|
+
as: :divider
|
87
|
+
},
|
88
|
+
|
89
|
+
group: {
|
90
|
+
renders: lambda { |**system_arguments, &block|
|
91
|
+
Primer::Beta::NavList::Group.new(
|
92
|
+
selected_item_id: @selected_item_id,
|
93
|
+
**system_arguments,
|
94
|
+
&block
|
95
|
+
)
|
96
|
+
},
|
97
|
+
|
98
|
+
as: :group
|
99
|
+
}
|
100
|
+
}
|
101
|
+
|
102
|
+
# @param selected_item_id [Symbol] The ID of the currently selected item. The default is `nil`, meaning no item is selected.
|
103
|
+
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
|
104
|
+
def initialize(selected_item_id: nil, **system_arguments)
|
105
|
+
@system_arguments = system_arguments
|
106
|
+
@selected_item_id = selected_item_id
|
107
|
+
end
|
108
|
+
|
109
|
+
# Builds a new item but does not add it to the list. Use this method
|
110
|
+
# instead of the `#with_item` slot if you need to render an item outside
|
111
|
+
# the context of a list, eg. if rendering additional items to append to
|
112
|
+
# an existing list, perhaps via a separate HTTP request.
|
113
|
+
#
|
114
|
+
# @param component_klass [Class] The class to use instead of the default <%= link_to_component(Primer::Beta::NavList::Item) %>
|
115
|
+
# @param system_arguments [Hash] These arguments are forwarded to <%= link_to_component(Primer::Beta::NavList::Item) %>, or whatever class is passed as the `component_klass` argument.
|
116
|
+
def build_item(component_klass: Primer::Beta::NavList::Item, **system_arguments, &block)
|
117
|
+
component_klass.new(
|
118
|
+
list: top_level_group,
|
119
|
+
selected_item_id: @selected_item_id,
|
120
|
+
**system_arguments,
|
121
|
+
&block
|
122
|
+
)
|
123
|
+
end
|
124
|
+
|
125
|
+
# Builds a new avatar item but does not add it to the list. Avatar items
|
126
|
+
# are a convenient way to accessibly add an item with a leading avatar
|
127
|
+
# image. Use this method instead of the `#with_avatar_item` slot if you
|
128
|
+
# need to render an avatar item outside the context of a list, eg. if
|
129
|
+
# rendering additional items to append to an existing list, perhaps via
|
130
|
+
# a separate HTTP request.
|
131
|
+
#
|
132
|
+
# @param src [String] The source url of the avatar image.
|
133
|
+
# @param username [String] The username associated with the avatar.
|
134
|
+
# @param full_name [String] Optional. The user's full name.
|
135
|
+
# @param full_name_scheme [Symbol] Optional. How to display the user's full name. <%= one_of(Primer::Alpha::ActionList::Item::DESCRIPTION_SCHEME_OPTIONS) %>
|
136
|
+
# @param component_klass [Class] The class to use instead of the default <%= link_to_component(Primer::Beta::NavList::Item) %>
|
137
|
+
# @param avatar_arguments [Hash] Optional. The arguments accepted by <%= link_to_component(Primer::Beta::Avatar) %>
|
138
|
+
# @param system_arguments [Hash] These arguments are forwarded to <%= link_to_component(Primer::Beta::NavList::Item) %>, or whatever class is passed as the `component_klass` argument.
|
139
|
+
def build_avatar_item(src:, username:, full_name: nil, full_name_scheme: Primer::Alpha::ActionList::Item::DEFAULT_DESCRIPTION_SCHEME, component_klass: Primer::Beta::NavList::Item, avatar_arguments: {}, **system_arguments)
|
140
|
+
component_klass.new(
|
141
|
+
list: top_level_group,
|
142
|
+
selected_item_id: @selected_item_id,
|
143
|
+
label: username,
|
144
|
+
description_scheme: full_name_scheme,
|
145
|
+
**system_arguments
|
146
|
+
).tap do |item|
|
147
|
+
item.with_leading_visual_raw_content do
|
148
|
+
# no alt text necessary
|
149
|
+
item.render(Primer::Beta::Avatar.new(src: src, **avatar_arguments, role: :presentation, size: 16))
|
150
|
+
end
|
151
|
+
|
152
|
+
item.with_description_content(full_name) if full_name
|
153
|
+
end
|
154
|
+
end
|
155
|
+
|
156
|
+
private
|
157
|
+
|
158
|
+
def before_render
|
159
|
+
if heading?
|
160
|
+
raise ArgumentError, "Please don't set an aria-label if a heading is provided" if aria(:label, @system_arguments)
|
161
|
+
|
162
|
+
@system_arguments[:aria] = merge_aria(
|
163
|
+
@system_arguments,
|
164
|
+
{ aria: { labelledby: heading.id } }
|
165
|
+
)
|
166
|
+
else
|
167
|
+
raise ArgumentError, "When no heading is provided, an aria-label must be given" unless aria(:label, @system_arguments)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>
|
172
|
+
def render_outer_list?
|
173
|
+
items.any? { |item| !group?(item) }
|
174
|
+
end
|
175
|
+
|
176
|
+
def render_divider_between?(item1, item2)
|
177
|
+
return false if either_is_divider?(item1, item2)
|
178
|
+
|
179
|
+
both_are_groups?(item1, item2) || heterogeneous?(item1, item2)
|
180
|
+
end
|
181
|
+
|
182
|
+
def both_are_groups?(item1, item2)
|
183
|
+
group?(item1) && group?(item2)
|
184
|
+
end
|
185
|
+
|
186
|
+
def heterogeneous?(item1, item2)
|
187
|
+
kind(item1) != kind(item2)
|
188
|
+
end
|
189
|
+
|
190
|
+
def either_is_divider?(item1, item2)
|
191
|
+
divider?(item1) || divider?(item2)
|
192
|
+
end
|
193
|
+
|
194
|
+
def group?(item)
|
195
|
+
kind(item) == :group
|
196
|
+
end
|
197
|
+
|
198
|
+
def divider?(item)
|
199
|
+
kind(item) == :divider
|
200
|
+
end
|
201
|
+
|
202
|
+
def kind(item)
|
203
|
+
item.respond_to?(:kind) ? item.kind : :item
|
204
|
+
end
|
205
|
+
|
206
|
+
def top_level_group
|
207
|
+
# dummy group for the list: argument in the item slot above
|
208
|
+
@top_level_group ||= Primer::Beta::NavList::Group.new(selected_item_id: @selected_item_id)
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
@@ -9,15 +9,17 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
9
9
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
10
10
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
11
11
|
};
|
12
|
-
var _FocusGroupElement_instances, _FocusGroupElement_abortController, _FocusGroupElement_items_get;
|
12
|
+
var _FocusGroupElement_instances, _FocusGroupElement_retainSignal, _FocusGroupElement_abortController, _FocusGroupElement_items_get;
|
13
13
|
import '@oddbird/popover-polyfill';
|
14
|
-
const
|
14
|
+
const validSelectors = ['[role="menuitem"]', '[role="menuitemcheckbox"]', '[role="menuitemradio"]'];
|
15
|
+
const menuItemSelector = validSelectors.map(selector => `:not([hidden]) > ${selector}`).join(', ');
|
15
16
|
const getMnemonicFor = (item) => { var _a; return (_a = item.textContent) === null || _a === void 0 ? void 0 : _a.trim()[0].toLowerCase(); };
|
16
17
|
const printable = /^\S$/;
|
17
18
|
export default class FocusGroupElement extends HTMLElement {
|
18
19
|
constructor() {
|
19
20
|
super(...arguments);
|
20
21
|
_FocusGroupElement_instances.add(this);
|
22
|
+
_FocusGroupElement_retainSignal.set(this, null);
|
21
23
|
_FocusGroupElement_abortController.set(this, null);
|
22
24
|
}
|
23
25
|
get nowrap() {
|
@@ -56,11 +58,35 @@ export default class FocusGroupElement extends HTMLElement {
|
|
56
58
|
(_a = __classPrivateFieldGet(this, _FocusGroupElement_abortController, "f")) === null || _a === void 0 ? void 0 : _a.abort();
|
57
59
|
}
|
58
60
|
handleEvent(event) {
|
61
|
+
var _a;
|
59
62
|
const { direction, nowrap } = this;
|
60
63
|
if (event.type === 'focusin') {
|
61
64
|
if (this.retain && event.target instanceof Element && event.target.matches(menuItemSelector)) {
|
65
|
+
(_a = __classPrivateFieldGet(this, _FocusGroupElement_retainSignal, "f")) === null || _a === void 0 ? void 0 : _a.abort();
|
66
|
+
const { signal } = (__classPrivateFieldSet(this, _FocusGroupElement_retainSignal, new AbortController(), "f"));
|
62
67
|
for (const item of __classPrivateFieldGet(this, _FocusGroupElement_instances, "a", _FocusGroupElement_items_get)) {
|
63
68
|
item.setAttribute('tabindex', item === event.target ? '0' : '-1');
|
69
|
+
const popover = event.target.closest('[popover]');
|
70
|
+
if (item === event.target && (popover === null || popover === void 0 ? void 0 : popover.popover) === 'auto' && popover.closest('focus-group') === this) {
|
71
|
+
popover.addEventListener('toggle', (toggleEvent) => {
|
72
|
+
var _a, _b;
|
73
|
+
if (!(toggleEvent.target instanceof Element))
|
74
|
+
return;
|
75
|
+
if (toggleEvent.newState === 'closed') {
|
76
|
+
(_a = __classPrivateFieldGet(this, _FocusGroupElement_retainSignal, "f")) === null || _a === void 0 ? void 0 : _a.abort();
|
77
|
+
item.setAttribute('tabindex', '-1');
|
78
|
+
if (popover.id) {
|
79
|
+
const invoker = this.querySelector(`[popovertarget="${popover.id}"]`);
|
80
|
+
if (invoker) {
|
81
|
+
invoker.setAttribute('tabindex', '0');
|
82
|
+
}
|
83
|
+
else {
|
84
|
+
(_b = __classPrivateFieldGet(this, _FocusGroupElement_instances, "a", _FocusGroupElement_items_get)[0]) === null || _b === void 0 ? void 0 : _b.setAttribute('tabindex', '0');
|
85
|
+
}
|
86
|
+
}
|
87
|
+
}
|
88
|
+
}, { signal });
|
89
|
+
}
|
64
90
|
}
|
65
91
|
}
|
66
92
|
}
|
@@ -120,7 +146,7 @@ export default class FocusGroupElement extends HTMLElement {
|
|
120
146
|
let el = focusEl;
|
121
147
|
do {
|
122
148
|
el = el.closest(`[popover]:not(:popover-open)`);
|
123
|
-
if ((el === null || el === void 0 ? void 0 : el.popover) === 'auto') {
|
149
|
+
if ((el === null || el === void 0 ? void 0 : el.popover) === 'auto' && !['ArrowRight', 'ArrowLeft'].includes(event.key)) {
|
124
150
|
el.showPopover();
|
125
151
|
}
|
126
152
|
el = (el === null || el === void 0 ? void 0 : el.parentElement) || null;
|
@@ -130,7 +156,7 @@ export default class FocusGroupElement extends HTMLElement {
|
|
130
156
|
}
|
131
157
|
}
|
132
158
|
}
|
133
|
-
_FocusGroupElement_abortController = new WeakMap(), _FocusGroupElement_instances = new WeakSet(), _FocusGroupElement_items_get = function _FocusGroupElement_items_get() {
|
159
|
+
_FocusGroupElement_retainSignal = new WeakMap(), _FocusGroupElement_abortController = new WeakMap(), _FocusGroupElement_instances = new WeakSet(), _FocusGroupElement_items_get = function _FocusGroupElement_items_get() {
|
134
160
|
return this.querySelectorAll(menuItemSelector);
|
135
161
|
};
|
136
162
|
if (!customElements.get('focus-group')) {
|