Make include sub items checkbox hideable

Author: HDinger

app/components/primer/open_project/filterable_tree_view.html.erb

@@ -7,7 +7,7 @@
             <%= render(@filter_mode_control) %>
           <% end %>
         <% end %>
-        <%= render(Primer::Alpha::StackItem.new) do %>
+        <%= render(Primer::Alpha::StackItem.new(hidden: @include_sub_items_check_box_arguments[:hidden])) do %>
           <%= render(@include_sub_items_check_box) do |input| %>
             <% input.merge_input_arguments!(form: "") %>
           <% end %>

app/components/primer/open_project/filterable_tree_view.rb

@@ -126,7 +126,9 @@ class FilterableTreeView < Primer::Component
 
       DEFAULT_INCLUDE_SUB_ITEMS_CHECK_BOX_ARGUMENTS = {
         label: I18n.t("filterable_tree_view.include_sub_items"),
-        name: :include_sub_items
+        name: :include_sub_items,
+        checked: false,
+        hidden: false,
       }
 
       DEFAULT_INCLUDE_SUB_ITEMS_CHECK_BOX_ARGUMENTS.freeze
@@ -194,13 +196,15 @@ def initialize(
           @filter_mode_control = Primer::Alpha::SegmentedControl.new(**filter_mode_control_arguments)
         end
 
-        include_sub_items_check_box_arguments[:data] = merge_data(
-          include_sub_items_check_box_arguments, {
+        @include_sub_items_check_box_arguments = include_sub_items_check_box_arguments.reverse_merge(DEFAULT_INCLUDE_SUB_ITEMS_CHECK_BOX_ARGUMENTS)
+
+        @include_sub_items_check_box_arguments[:data] = merge_data(
+          @include_sub_items_check_box_arguments, {
             data: { target: "filterable-tree-view.includeSubItemsCheckBox" }
           }
         )
 
-        @include_sub_items_check_box = Primer::Alpha::CheckBox.new(**include_sub_items_check_box_arguments)
+        @include_sub_items_check_box = Primer::Alpha::CheckBox.new(**@include_sub_items_check_box_arguments)
 
         @system_arguments = deny_tag_argument(**system_arguments)
         @system_arguments[:tag] = :"filterable-tree-view"

previews/primer/open_project/filterable_tree_view_preview.rb

@@ -7,9 +7,13 @@ class FilterableTreeViewPreview < ViewComponent::Preview
       # @label Playground
       #
       # @param expanded [Boolean] toggle
-      def playground(expanded: true)
+      # @param show_checkbox [Boolean] toggle
+      # @param show_segmented_control [Boolean] toggle
+      def playground(expanded: true, show_checkbox: true, show_segmented_control: true)
         render_with_template(locals: {
-          expanded: coerce_bool(expanded)
+          expanded: coerce_bool(expanded),
+          show_checkbox: coerce_bool(show_checkbox),
+          show_segmented_control: coerce_bool(show_segmented_control)
         })
       end
 
@@ -106,6 +110,16 @@ def custom_checkbox_text(expanded: true)
         })
       end
 
+      # @label Hide checkbox
+      #
+      # @param include_sub_items [Boolean] toggle
+      def hide_checkbox(include_sub_items: true)
+        render_with_template(locals: {
+          expanded: true,
+          include_sub_items: coerce_bool(include_sub_items)
+        })
+      end
+
       # @label Hide SegmentedControl
       def hide_segmented_control(expanded: true)
         render_with_template(locals: {

previews/primer/open_project/filterable_tree_view_preview/hide_checkbox.html.erb

@@ -0,0 +1,28 @@
+<%= render(Primer::OpenProject::FilterableTreeView.new(
+  include_sub_items_check_box_arguments: { hidden: true, checked: include_sub_items }
+)) do |tree| %>
+  <% tree.with_sub_tree(label: "Students", expanded: expanded) do |hogwarts| %>
+    <% hogwarts.with_sub_tree(label: "Ravenclaw", expanded: expanded) do |ravenclaw| %>
+      <% ravenclaw.with_leaf(label: "Luna Lovegood") %>
+    <% end %>
+
+    <% hogwarts.with_sub_tree(label: "Slytherin", expanded: expanded) do |hufflepuff| %>
+      <% hufflepuff.with_leaf(label: "Draco Malfoy") %>
+    <% end %>
+
+    <% hogwarts.with_sub_tree(label: "Hufflepuff", expanded: expanded) do |hufflepuff| %>
+      <% hufflepuff.with_leaf(label: "Susan Bones") %>
+    <% end %>
+
+    <% hogwarts.with_sub_tree(label: "Gryffindor", expanded: expanded) do |hufflepuff| %>
+      <% hufflepuff.with_leaf(label: "Harry Potter") %>
+      <% hufflepuff.with_leaf(label: "Ronald Weasley") %>
+      <% hufflepuff.with_leaf(label: "Hermione Granger") %>
+    <% end %>
+  <% end %>
+
+  <% tree.with_leaf(label: "Albus Dumbledore") %>
+  <% tree.with_leaf(label: "Minerva McGonagall") %>
+  <% tree.with_leaf(label: "Severus Snape") %>
+  <% tree.with_leaf(label: "Rubeus Hagrid") %>
+<% end %>

previews/primer/open_project/filterable_tree_view_preview/playground.html.erb

@@ -1,4 +1,7 @@
-<%= render(Primer::OpenProject::FilterableTreeView.new) do |tree| %>
+<%= render(Primer::OpenProject::FilterableTreeView.new(
+  include_sub_items_check_box_arguments: { hidden: !show_checkbox },
+  **(show_segmented_control ? {} : { filter_mode_control_arguments: :none })
+)) do |tree| %>
   <% tree.with_sub_tree(label: "Students", expanded: expanded) do |hogwarts| %>
     <% hogwarts.with_sub_tree(label: "Ravenclaw", expanded: expanded) do |ravenclaw| %>
       <% ravenclaw.with_leaf(label: "Luna Lovegood") %>

test/components/primer/open_project/filterable_tree_view_test.rb

@@ -71,6 +71,28 @@ def test_has_include_sub_items_check_box
         assert_selector("label[for='#{id}']", text: "Include sub-items")
       end
 
+      def test_include_sub_items_can_be_hidden
+        render_inline(
+          Primer::OpenProject::FilterableTreeView.new(
+            include_sub_items_check_box_arguments: { hidden: true }
+          )
+        )
+
+        assert_selector(".FormControl-checkbox-wrap", visible: :hidden)
+        assert_selector("input[name=include_sub_items]", visible: :hidden)
+      end
+
+      def test_include_sub_items_can_have_a_different_default
+        render_inline(
+          Primer::OpenProject::FilterableTreeView.new(
+            include_sub_items_check_box_arguments: { checked: true }
+          )
+        )
+
+        assert_selector(".FormControl-checkbox-wrap", visible: :visible)
+        assert_selector("input[name=include_sub_items][checked=checked]", visible: :visible)
+      end
+
       def test_has_filter_input
         render_preview(:default)