openproject-primer_view_components 0.57.0 → 0.58.0

data/app/components/primer/alpha/select_panel.html.erb

@@ -1,4 +1,9 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <% if required_form_arguments_given? %>
+    <span data-select-panel-inputs="true">
+        <%= @form_builder.hidden_field(@input_name, multiple: multi_select?, skip_default_ids: true, value: @value) %>
+    </span>
+  <% end %>
   <dialog-helper>
     <%= show_button %>
     <%= render(@dialog) do %>

data/app/components/primer/alpha/select_panel.rb

@@ -152,27 +152,6 @@ module Primer
     #   end
     # end
     # ```
-    #
-    # If items are provided dynamically, things become a bit more complicated. The `form_for` or `form_with` method call
-    # happens in the view that renders the `SelectPanel`, which means the form builder object but isn't available in the
-    # view that renders the list items. In such a case, it can be useful to create an instance of the form builder maually:
-    #
-    # ```erb
-    # <% builder = ActionView::Helpers::FormBuilder.new(
-    #   "address",  # the name of the model, used to wrap input names, eg 'address[country]'
-    #   nil,        # object (eg. the Address instance, which we can omit)
-    #   self,       # template
-    #   {}          # options
-    # ) %>
-    # <%= render(Primer::Alpha::SelectPanel::ItemList.new(
-    #   form_arguments: { builder: builder, name: "country" }
-    # )) do |list| %>
-    #   <% countries.each do |country| %>
-    #     <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>
-    #   <% end %>
-    # <% end %>
-    # ```
-    #
     # ### JavaScript API
     #
     # `SelectPanel`s render a `<select-panel>` custom element that exposes behavior to the client.
@@ -375,7 +354,9 @@ module Primer
       # @param dynamic_aria_label_prefix [String] If provided, the prefix is prepended to the dynamic label and set as the value of the `aria-label` attribute on the show button.
       # @param body_id [String] The unique ID of the panel body. If not provided, the body ID will be set to the panel ID with a "-body" suffix.
       # @param list_arguments [Hash] Arguments to pass to the underlying <%= link_to_component(Primer::Alpha::ActionList) %> component. Only has an effect for the local fetch strategy.
-      # @param form_arguments [Hash] Form arguments to pass to the underlying <%= link_to_component(Primer::Alpha::ActionList) %> component. Only has an effect for the local fetch strategy.
+      # @param form_arguments [Hash] Form arguments
+
+      # @param use_experimental_non_local_form [Boolean] A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values.
       # @param show_filter [Boolean] Whether or not to show the filter input.
       # @param open_on_load [Boolean] Open the panel when the page loads.
       # @param anchor_align [Symbol] The anchor alignment of the Overlay. <%= one_of(Primer::Alpha::Overlay::ANCHOR_ALIGN_OPTIONS) %>
@@ -397,6 +378,7 @@ module Primer
         dynamic_label_prefix: nil,
         dynamic_aria_label_prefix: nil,
         body_id: nil,
+        use_experimental_non_local_form: false,
         list_arguments: {},
         form_arguments: {},
         show_filter: true,
@@ -429,6 +411,15 @@ module Primer
         @dynamic_aria_label_prefix = dynamic_aria_label_prefix
         @loading_label = loading_label
         @loading_description_id = nil
+
+        if use_experimental_non_local_form
+          @form_builder = form_arguments[:builder]
+          @value = form_arguments[:value]
+          @input_name = form_arguments[:name]
+        end
+
+        @list_form_arguments = use_experimental_non_local_form ? {} : form_arguments
+
         if loading_description.present?
           @loading_description_id = "#{@panel_id}-loading-description"
         end
@@ -471,7 +462,7 @@ module Primer
 
         @list = Primer::Alpha::SelectPanel::ItemList.new(
           **list_arguments,
-          form_arguments: form_arguments,
+          form_arguments: @list_form_arguments, 
           id: "#{@panel_id}-list",
           select_variant: @select_variant,
           aria: {
@@ -546,6 +537,14 @@ module Primer
       def before_render
         content
       end
+
+      def required_form_arguments_given?
+        @input_name  && @form_builder
+      end
+
+      def multi_select?
+        select_variant == :multiple
+      end
     end
   end
-end
+end

data/app/components/primer/alpha/select_panel_element.js

@@ -893,7 +893,8 @@ _SelectPanelElement_setDynamicLabel = function _SelectPanelElement_setDynamicLab
 };
 _SelectPanelElement_updateInput = function _SelectPanelElement_updateInput() {
     if (this.selectVariant === 'single') {
-        const input = this.querySelector(`[data-list-inputs=true] input`);
+        const input = this.querySelector(`[data-select-panel-inputs=true] input`) ??
+            this.querySelector(`[data-list-inputs=true] input`);
         if (!input)
             return;
         const selectedItem = this.selectedItems[0];
@@ -903,13 +904,14 @@ _SelectPanelElement_updateInput = function _SelectPanelElement_updateInput() {
                 input.name = selectedItem.inputName;
             input.removeAttribute('disabled');
         }
-        else {
+        else if (__classPrivateFieldGet(this, _SelectPanelElement_hasLoadedData, "f")) {
             input.setAttribute('disabled', 'disabled');
         }
     }
     else if (this.selectVariant !== 'none') {
         // multiple select variant
-        const inputList = this.querySelector('[data-list-inputs=true]');
+        const isRemoteInput = !!this.querySelector('[data-select-panel-inputs=true]');
+        const inputList = this.querySelector('[data-select-panel-inputs=true]') ?? this.querySelector('[data-list-inputs=true]');
         if (!inputList)
             return;
         const inputs = inputList.querySelectorAll('input');
@@ -918,7 +920,7 @@ _SelectPanelElement_updateInput = function _SelectPanelElement_updateInput() {
         }
         for (const selectedItem of this.selectedItems) {
             const newInput = document.createElement('input');
-            newInput.setAttribute('data-list-input', 'true');
+            newInput.setAttribute(`${isRemoteInput ? 'data-select-panel-input' : 'data-list-input'}`, 'true');
             newInput.type = 'hidden';
             newInput.autocomplete = 'off';
             newInput.name = selectedItem.inputName || __classPrivateFieldGet(this, _SelectPanelElement_inputName, "f");

data/app/components/primer/alpha/select_panel_element.ts

@@ -959,7 +959,9 @@ export class SelectPanelElement extends HTMLElement {
 
   #updateInput() {
     if (this.selectVariant === 'single') {
-      const input = this.querySelector(`[data-list-inputs=true] input`) as HTMLInputElement
+      const input =
+        (this.querySelector(`[data-select-panel-inputs=true] input`) as HTMLInputElement) ??
+        (this.querySelector(`[data-list-inputs=true] input`) as HTMLInputElement)
       if (!input) return
 
       const selectedItem = this.selectedItems[0]
@@ -968,12 +970,14 @@ export class SelectPanelElement extends HTMLElement {
         input.value = (selectedItem.value || selectedItem.label || '').trim()
         if (selectedItem.inputName) input.name = selectedItem.inputName
         input.removeAttribute('disabled')
-      } else {
+      } else if (this.#hasLoadedData) {
         input.setAttribute('disabled', 'disabled')
       }
     } else if (this.selectVariant !== 'none') {
       // multiple select variant
-      const inputList = this.querySelector('[data-list-inputs=true]')
+      const isRemoteInput = !!this.querySelector('[data-select-panel-inputs=true]')
+      const inputList =
+        this.querySelector('[data-select-panel-inputs=true]') ?? this.querySelector('[data-list-inputs=true]')
       if (!inputList) return
 
       const inputs = inputList.querySelectorAll('input')
@@ -984,7 +988,7 @@ export class SelectPanelElement extends HTMLElement {
 
       for (const selectedItem of this.selectedItems) {
         const newInput = document.createElement('input')
-        newInput.setAttribute('data-list-input', 'true')
+        newInput.setAttribute(`${isRemoteInput ? 'data-select-panel-input' : 'data-list-input'}`, 'true')
         newInput.type = 'hidden'
         newInput.autocomplete = 'off'
         newInput.name = selectedItem.inputName || this.#inputName

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
   module ViewComponents
     module VERSION
       MAJOR = 0
-      MINOR = 57
+      MINOR = 58
       PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")

data/previews/primer/alpha/select_panel_preview/remote_fetch_form.html.erb

@@ -0,0 +1,34 @@
+<% subject_id = SecureRandom.hex %>
+
+<%= form_with(url: generic_form_submission_path(format: route_format)) do |builder| %>
+  <%= render(Primer::Alpha::SelectPanel.new(
+    data: { interaction_subject: subject_id },
+    select_variant: :single,
+    src: select_panel_items_path(
+        select_variant: :single,
+        selected_items: selected_items,
+    ),
+    open_on_load: open_on_load,
+    dynamic_label: true,
+    dynamic_label_prefix: "Item",
+    use_experimental_non_local_form: true,
+    form_arguments: {
+      name: :item,
+      builder: builder,
+      value: 3,
+    }
+  )) do |panel| %>
+    <% panel.with_show_button { "Sci-fi equipment" } %>
+    <% panel.with_footer(show_divider: true) do %>
+        I'm a footer!
+    <% end %>
+  <% end %>
+
+  <hr>
+
+  <%= render(Primer::Beta::Button.new(type: :submit, scheme: :primary)) do %>
+    Submit
+  <% end %>
+<% end %>
+
+<%= render partial: "primer/alpha/select_panel_preview/interaction_subject_js", locals: { subject_id: subject_id } %>

data/previews/primer/alpha/select_panel_preview.rb

@@ -259,6 +259,15 @@ module Primer
         render_with_template(locals: { open_on_load: open_on_load, route_format: route_format })
       end
 
+      # @label Remote fetch form
+      #
+      # @snapshot interactive
+      # @param open_on_load toggle
+      # @param selected_items text
+      def remote_fetch_form(open_on_load: false, selected_items: "Phaser",  route_format: :html)
+        render_with_template(locals: { open_on_load: open_on_load, selected_items: selected_items, route_format: route_format })
+      end
+
       # @label Multi-select form
       #
       # @snapshot interactive

data/static/arguments.json

@@ -2345,88 +2345,10 @@
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select_panel/default/",
     "parameters": [
       {
-        "name": "src",
-        "type": "String",
-        "default": "`nil`",
-        "description": "The URL to fetch search results from."
-      },
-      {
-        "name": "title",
-        "type": "String",
-        "default": "`\"Menu\"`",
-        "description": "The title that appears at the top of the panel."
-      },
-      {
-        "name": "id",
-        "type": "String",
-        "default": "`self.class.generate_id`",
-        "description": "The unique ID of the panel."
-      },
-      {
-        "name": "size",
-        "type": "Symbol",
-        "default": "`:small`",
-        "description": "The size of the panel. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
-      },
-      {
-        "name": "select_variant",
-        "type": "Symbol",
-        "default": "`:single`",
-        "description": "One of `:multiple`, `:none`, or `:single`."
-      },
-      {
-        "name": "fetch_strategy",
-        "type": "Symbol",
-        "default": "`:remote`",
-        "description": "One of `:eventually_local`, `:local`, or `:remote`."
-      },
-      {
-        "name": "no_results_label",
-        "type": "String",
-        "default": "`\"No results found\"`",
-        "description": "The label to display when no results are found."
-      },
-      {
-        "name": "preload",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened."
-      },
-      {
-        "name": "dynamic_label",
+        "name": "use_experimental_non_local_form",
         "type": "Boolean",
         "default": "`false`",
-        "description": "Whether or not to display the text of the currently selected item in the show button."
-      },
-      {
-        "name": "dynamic_label_prefix",
-        "type": "String",
-        "default": "`nil`",
-        "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
-      },
-      {
-        "name": "dynamic_aria_label_prefix",
-        "type": "String",
-        "default": "`nil`",
-        "description": "If provided, the prefix is prepended to the dynamic label and set as the value of the `aria-label` attribute on the show button."
-      },
-      {
-        "name": "body_id",
-        "type": "String",
-        "default": "`nil`",
-        "description": "The unique ID of the panel body. If not provided, the body ID will be set to the panel ID with a \"-body\" suffix."
-      },
-      {
-        "name": "list_arguments",
-        "type": "Hash",
-        "default": "`{}`",
-        "description": "Arguments to pass to the underlying [ActionList](/components/alpha/actionlist) component. Only has an effect for the local fetch strategy."
-      },
-      {
-        "name": "form_arguments",
-        "type": "Hash",
-        "default": "`{}`",
-        "description": "Form arguments to pass to the underlying [ActionList](/components/alpha/actionlist) component. Only has an effect for the local fetch strategy."
+        "description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values."
       },
       {
         "name": "show_filter",

data/static/info_arch.json

@@ -7438,7 +7438,7 @@
   },
   {
     "fully_qualified_name": "Primer::Alpha::SelectPanel",
-    "description": "Select panels allow for selecting from a large number of options and can be thought of as a more capable\nversion of the traditional HTML `<select>` element.\n\nSelect panels:\n\n1. feature an input field at the top that allows an end user to filter the list of results.\n1. can render their items statically or dynamically by fetching results from the server.\n1. allow selecting a single item or multiple items.\n1. permit leading visuals like Octicons, avatars, and custom SVGs.\n1. can be used as form inputs in Rails forms.\n\n## Static list items\n\nThe Rails `SelectPanel` component allows items to be provided statically or loaded dynamically from the\nserver. Providing items statically is done using a fetch strategy of `:local` in combination with the\n`item` slot:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new(fetch_strategy: :local))) do |panel| %>\n  <% panel.with_show_button { \"Select item\" } %>\n  <% panel.with_item(label: \"Item 1\") %>\n  <% panel.with_item(label: \"Item 2\") %>\n<% end %>\n```\n\n## Dynamic list items\n\nList items can also be fetched dynamically from the server and will require creating a Rails controller action\nto respond with the list of items in addition to rendering the `SelectPanel` instance. Render the instance as\nnormal, providing your desired [fetch strategy](#fetch-strategies):\n\n```erb\n<%= render(\n  Primer::Alpha::SelectPanel.new(\n    fetch_strategy: :remote,\n    src: search_items_path  # perhaps a Rails URL helper\n  )\n) %>\n```\n\nDefine a controller action to serve the list of items. The `SelectPanel` component passes any filter text in\nthe `q=` URL parameter.\n\n```ruby\nclass SearchItemsController < ApplicationController\n  def show\n    # NOTE: params[:q] may be nil since there is no filter string available\n    # when the panel is first opened\n    @results = SomeModel.search(params[:q] || \"\")\n  end\nend\n```\n\nResponses must be HTML fragments, eg. have a content type of `text/html+fragment`. This content type isn't\navailable by default in Rails, so you may have to register it eg. in an initializer:\n\n```ruby\nMime::Type.register(\"text/fragment+html\", :html_fragment)\n```\n\nRender a `Primer::Alpha::SelectPanel::ItemList` in the action's template, search_items/show.html_fragment.erb:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n  <% @results.each do |result| %>\n    <% list.with_item(label: result.title) do |item| %>\n      <% item.with_description(result.description) %>\n    <% end %>\n  <% end %>\n<% end %>\n```\n\n### Selection consistency\n\nThe `SelectPanel` component automatically \"remembers\" which items have been selected across item fetch requests,\nmeaning the controller that renders dynamic list items does not (and should not) remember these selections or\npersist them until the user has confirmed them, either by submitting the form or otherwise indicating completion.\nThe `SelectPanel` component does not include unconfirmed selection data in requests.\n\n## Fetch strategies\n\nThe list of items can be fetched from a remote URL, or provided as a static list, configured using the\n`fetch_strategy` attribute. Fetch strategies are summarized below.\n\n1. `:remote`: a query is made to the URL in the `src` attribute every time the input field changes.\n\n2. `:eventually_local`: a query is made to the URL in the `src` attribute when the panel is first opened. The\n    results are \"remembered\" and filtered in-memory for all subsequent filter operations, i.e. when the input\n    field changes.\n\n3. `:local`: the list of items is provided statically ahead of time and filtered in-memory. No requests are made\n    to the server.\n\n## Customizing filter behavior\n\nIf the fetch strategy is `:remote`, then filtering is handled server-side. The server should render a\n`Primer::Alpha::SelectPanel::ItemList` (an alias of {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}})\nin the response containing the filtered list of items. The component achieves remote fetching via the\n[remote-input-element](https://github.com/github/remote-input-element), which sends a request to the\nserver with the filter string in the `q=` parameter. Responses must be HTML fragments, eg. have a content\ntype of `text/html+fragment`.\n\n### Local filtering\n\nIf the fetch strategy is `:local` or `:eventually_local`, filtering is performed client-side. Filter behavior can\nbe customized in JavaScript by setting the `filterFn` attribute on the instance of `SelectPanelElement`, eg:\n\n```javascript\ndocument.querySelector(\"select-panel\").filterFn = (item: HTMLElement, query: string): boolean => {\n  // return true if the item should be displayed, false otherwise\n}\n```\n\nThe element's default filter function uses the value of the `data-filter-string` attribute, falling back to the\nelement's `innerText` property. It performs a case-insensitive substring match against the filter string.\n\n### `SelectPanel`s as form inputs\n\n`SelectPanel`s can be used as form inputs. They behave very similarly to how HTML `<select>` boxes behave, and\nplay nicely with Rails' built-in form mechanisms. Pass arguments via the `form_arguments:` argument, including\nthe Rails form builder object and the name of the field. Each list item must also have a value specified in\n`content_arguments: { data: { value: } }`.\n\n```erb\n<% form_with(model: Address.new) do |f| %>\n  <%= render(Primer::Alpha::SelectPanel.new(form_arguments: { builder: f, name: \"country\" })) do |menu| %>\n    <% countries.each do |country|\n      <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n    <% end %>\n  <% end %>\n<% end %>\n```\n\nThe value of the `data: { value: ... }` argument is sent to the server on submit, keyed using the name provided above\n(eg. `\"country\"`). If no value is provided for an item, the value of that item is the item's label.  Here's the\ncorresponding `AddressesController` that might be written to handle the form above:\n\n```ruby\nclass AddressesController < ApplicationController\n  def create\n    puts \"You chose #{address_params[:country]} as your country\"\n  end\n\n  private\n\n  def address_params\n    params.require(:address).permit(:country)\n  end\nend\n```\n\nIf items are provided dynamically, things become a bit more complicated. The `form_for` or `form_with` method call\nhappens in the view that renders the `SelectPanel`, which means the form builder object but isn't available in the\nview that renders the list items. In such a case, it can be useful to create an instance of the form builder maually:\n\n```erb\n<% builder = ActionView::Helpers::FormBuilder.new(\n  \"address\",  # the name of the model, used to wrap input names, eg 'address[country]'\n  nil,        # object (eg. the Address instance, which we can omit)\n  self,       # template\n  {}          # options\n) %>\n<%= render(Primer::Alpha::SelectPanel::ItemList.new(\n  form_arguments: { builder: builder, name: \"country\" }\n)) do |list| %>\n  <% countries.each do |country| %>\n    <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n  <% end %>\n<% end %>\n```\n\n### JavaScript API\n\n`SelectPanel`s render a `<select-panel>` custom element that exposes behavior to the client.\n\n#### Utility methods\n\n* `show()`: Manually open the panel. Under normal circumstances, a show button is used to show the panel, but this method exists to support unusual use-cases.\n* `hide()`: Manually hides (closes) the panel.\n\n#### Query methods\n\n* `getItemById(itemId: string): Element`: Returns the item's HTML `<li>` element. The return value can be passed as the `item` argument to the other methods listed below.\n* `isItemChecked(item: Element): boolean`: Returns `true` if the item is checked, `false` otherwise.\n* `isItemHidden(item: Element): boolean`: Returns `true` if the item is hidden, `false` otherwise.\n* `isItemDisabled(item: Element): boolean`: Returns `true` if the item is disabled, `false` otherwise.\n\nNOTE: Item IDs are special values provided by the user that are attached to `SelectPanel` list items as the `data-item-id`\nHTML attribute. Item IDs can be provided by passing an `item_id:` attribute when adding items to the panel, eg:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new) do |panel| %>\n  <% panel.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\nThe same is true when rendering `ItemList`s:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n  <% list.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\n#### State methods\n\n* `enableItem(item: Element)`: Enables the item, i.e. makes it clickable by the mouse and keyboard.\n* `disableItem(item: Element)`: Disables the item, i.e. makes it unclickable by the mouse and keyboard.\n* `checkItem(item: Element)`: Checks the item. Only has an effect in single- and multi-select modes.\n* `uncheckItem(item: Element)`: Unchecks the item. Only has an effect in multi-select mode, since items cannot be unchecked in single-select mode.\n\n#### Events\n\n|Name                 |Type                                       |Bubbles |Cancelable |\n|:--------------------|:------------------------------------------|:-------|:----------|\n|`itemActivated`      |`CustomEvent<ItemActivatedEvent>`          |Yes     |No         |\n|`beforeItemActivated`|`CustomEvent<ItemActivatedEvent>`          |Yes     |Yes        |\n|`dialog:open`        |`CustomEvent<{dialog: HTMLDialogElement}>` |No      |No         |\n|`panelClosed`        |`CustomEvent<{panel: SelectPanelElement}>` |Yes     |No         |\n\n_Item activation_\n\nThe `<select-panel>` element fires an `itemActivated` event whenever an item is activated (eg. clicked) via the mouse or keyboard.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n  \"itemActivated\",\n  (event: CustomEvent<ItemActivatedEvent>) => {\n    event.detail.item     // Element: the <li> item that was activated\n    event.detail.checked  // boolean: whether or not the result of the activation checked the item\n  }\n)\n```\n\nThe `beforeItemActivated` event fires before an item is activated. Canceling this event will prevent the item\nfrom being activated.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n  \"beforeItemActivated\",\n  (event: CustomEvent<ItemActivatedEvent>) => {\n    event.detail.item      // Element: the <li> item that was activated\n    event.detail.checked   // boolean: whether or not the result of the activation checked the item\n    event.preventDefault() // Cancel the event to prevent activation (eg. checking/unchecking)\n  }\n)\n```",
+    "description": "Select panels allow for selecting from a large number of options and can be thought of as a more capable\nversion of the traditional HTML `<select>` element.\n\nSelect panels:\n\n1. feature an input field at the top that allows an end user to filter the list of results.\n1. can render their items statically or dynamically by fetching results from the server.\n1. allow selecting a single item or multiple items.\n1. permit leading visuals like Octicons, avatars, and custom SVGs.\n1. can be used as form inputs in Rails forms.\n\n## Static list items\n\nThe Rails `SelectPanel` component allows items to be provided statically or loaded dynamically from the\nserver. Providing items statically is done using a fetch strategy of `:local` in combination with the\n`item` slot:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new(fetch_strategy: :local))) do |panel| %>\n  <% panel.with_show_button { \"Select item\" } %>\n  <% panel.with_item(label: \"Item 1\") %>\n  <% panel.with_item(label: \"Item 2\") %>\n<% end %>\n```\n\n## Dynamic list items\n\nList items can also be fetched dynamically from the server and will require creating a Rails controller action\nto respond with the list of items in addition to rendering the `SelectPanel` instance. Render the instance as\nnormal, providing your desired [fetch strategy](#fetch-strategies):\n\n```erb\n<%= render(\n  Primer::Alpha::SelectPanel.new(\n    fetch_strategy: :remote,\n    src: search_items_path  # perhaps a Rails URL helper\n  )\n) %>\n```\n\nDefine a controller action to serve the list of items. The `SelectPanel` component passes any filter text in\nthe `q=` URL parameter.\n\n```ruby\nclass SearchItemsController < ApplicationController\n  def show\n    # NOTE: params[:q] may be nil since there is no filter string available\n    # when the panel is first opened\n    @results = SomeModel.search(params[:q] || \"\")\n  end\nend\n```\n\nResponses must be HTML fragments, eg. have a content type of `text/html+fragment`. This content type isn't\navailable by default in Rails, so you may have to register it eg. in an initializer:\n\n```ruby\nMime::Type.register(\"text/fragment+html\", :html_fragment)\n```\n\nRender a `Primer::Alpha::SelectPanel::ItemList` in the action's template, search_items/show.html_fragment.erb:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n  <% @results.each do |result| %>\n    <% list.with_item(label: result.title) do |item| %>\n      <% item.with_description(result.description) %>\n    <% end %>\n  <% end %>\n<% end %>\n```\n\n### Selection consistency\n\nThe `SelectPanel` component automatically \"remembers\" which items have been selected across item fetch requests,\nmeaning the controller that renders dynamic list items does not (and should not) remember these selections or\npersist them until the user has confirmed them, either by submitting the form or otherwise indicating completion.\nThe `SelectPanel` component does not include unconfirmed selection data in requests.\n\n## Fetch strategies\n\nThe list of items can be fetched from a remote URL, or provided as a static list, configured using the\n`fetch_strategy` attribute. Fetch strategies are summarized below.\n\n1. `:remote`: a query is made to the URL in the `src` attribute every time the input field changes.\n\n2. `:eventually_local`: a query is made to the URL in the `src` attribute when the panel is first opened. The\n    results are \"remembered\" and filtered in-memory for all subsequent filter operations, i.e. when the input\n    field changes.\n\n3. `:local`: the list of items is provided statically ahead of time and filtered in-memory. No requests are made\n    to the server.\n\n## Customizing filter behavior\n\nIf the fetch strategy is `:remote`, then filtering is handled server-side. The server should render a\n`Primer::Alpha::SelectPanel::ItemList` (an alias of {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}})\nin the response containing the filtered list of items. The component achieves remote fetching via the\n[remote-input-element](https://github.com/github/remote-input-element), which sends a request to the\nserver with the filter string in the `q=` parameter. Responses must be HTML fragments, eg. have a content\ntype of `text/html+fragment`.\n\n### Local filtering\n\nIf the fetch strategy is `:local` or `:eventually_local`, filtering is performed client-side. Filter behavior can\nbe customized in JavaScript by setting the `filterFn` attribute on the instance of `SelectPanelElement`, eg:\n\n```javascript\ndocument.querySelector(\"select-panel\").filterFn = (item: HTMLElement, query: string): boolean => {\n  // return true if the item should be displayed, false otherwise\n}\n```\n\nThe element's default filter function uses the value of the `data-filter-string` attribute, falling back to the\nelement's `innerText` property. It performs a case-insensitive substring match against the filter string.\n\n### `SelectPanel`s as form inputs\n\n`SelectPanel`s can be used as form inputs. They behave very similarly to how HTML `<select>` boxes behave, and\nplay nicely with Rails' built-in form mechanisms. Pass arguments via the `form_arguments:` argument, including\nthe Rails form builder object and the name of the field. Each list item must also have a value specified in\n`content_arguments: { data: { value: } }`.\n\n```erb\n<% form_with(model: Address.new) do |f| %>\n  <%= render(Primer::Alpha::SelectPanel.new(form_arguments: { builder: f, name: \"country\" })) do |menu| %>\n    <% countries.each do |country|\n      <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n    <% end %>\n  <% end %>\n<% end %>\n```\n\nThe value of the `data: { value: ... }` argument is sent to the server on submit, keyed using the name provided above\n(eg. `\"country\"`). If no value is provided for an item, the value of that item is the item's label.  Here's the\ncorresponding `AddressesController` that might be written to handle the form above:\n\n```ruby\nclass AddressesController < ApplicationController\n  def create\n    puts \"You chose #{address_params[:country]} as your country\"\n  end\n\n  private\n\n  def address_params\n    params.require(:address).permit(:country)\n  end\nend\n```\n### JavaScript API\n\n`SelectPanel`s render a `<select-panel>` custom element that exposes behavior to the client.\n\n#### Utility methods\n\n* `show()`: Manually open the panel. Under normal circumstances, a show button is used to show the panel, but this method exists to support unusual use-cases.\n* `hide()`: Manually hides (closes) the panel.\n\n#### Query methods\n\n* `getItemById(itemId: string): Element`: Returns the item's HTML `<li>` element. The return value can be passed as the `item` argument to the other methods listed below.\n* `isItemChecked(item: Element): boolean`: Returns `true` if the item is checked, `false` otherwise.\n* `isItemHidden(item: Element): boolean`: Returns `true` if the item is hidden, `false` otherwise.\n* `isItemDisabled(item: Element): boolean`: Returns `true` if the item is disabled, `false` otherwise.\n\nNOTE: Item IDs are special values provided by the user that are attached to `SelectPanel` list items as the `data-item-id`\nHTML attribute. Item IDs can be provided by passing an `item_id:` attribute when adding items to the panel, eg:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new) do |panel| %>\n  <% panel.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\nThe same is true when rendering `ItemList`s:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n  <% list.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\n#### State methods\n\n* `enableItem(item: Element)`: Enables the item, i.e. makes it clickable by the mouse and keyboard.\n* `disableItem(item: Element)`: Disables the item, i.e. makes it unclickable by the mouse and keyboard.\n* `checkItem(item: Element)`: Checks the item. Only has an effect in single- and multi-select modes.\n* `uncheckItem(item: Element)`: Unchecks the item. Only has an effect in multi-select mode, since items cannot be unchecked in single-select mode.\n\n#### Events\n\n|Name                 |Type                                       |Bubbles |Cancelable |\n|:--------------------|:------------------------------------------|:-------|:----------|\n|`itemActivated`      |`CustomEvent<ItemActivatedEvent>`          |Yes     |No         |\n|`beforeItemActivated`|`CustomEvent<ItemActivatedEvent>`          |Yes     |Yes        |\n|`dialog:open`        |`CustomEvent<{dialog: HTMLDialogElement}>` |No      |No         |\n|`panelClosed`        |`CustomEvent<{panel: SelectPanelElement}>` |Yes     |No         |\n\n_Item activation_\n\nThe `<select-panel>` element fires an `itemActivated` event whenever an item is activated (eg. clicked) via the mouse or keyboard.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n  \"itemActivated\",\n  (event: CustomEvent<ItemActivatedEvent>) => {\n    event.detail.item     // Element: the <li> item that was activated\n    event.detail.checked  // boolean: whether or not the result of the activation checked the item\n  }\n)\n```\n\nThe `beforeItemActivated` event fires before an item is activated. Canceling this event will prevent the item\nfrom being activated.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n  \"beforeItemActivated\",\n  (event: CustomEvent<ItemActivatedEvent>) => {\n    event.detail.item      // Element: the <li> item that was activated\n    event.detail.checked   // boolean: whether or not the result of the activation checked the item\n    event.preventDefault() // Cancel the event to prevent activation (eg. checking/unchecking)\n  }\n)\n```",
     "accessibility_docs": null,
     "is_form_component": false,
     "is_published": true,
@@ -7451,88 +7451,10 @@
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select_panel/default/",
     "parameters": [
       {
-        "name": "src",
-        "type": "String",
-        "default": "`nil`",
-        "description": "The URL to fetch search results from."
-      },
-      {
-        "name": "title",
-        "type": "String",
-        "default": "`\"Menu\"`",
-        "description": "The title that appears at the top of the panel."
-      },
-      {
-        "name": "id",
-        "type": "String",
-        "default": "`self.class.generate_id`",
-        "description": "The unique ID of the panel."
-      },
-      {
-        "name": "size",
-        "type": "Symbol",
-        "default": "`:small`",
-        "description": "The size of the panel. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
-      },
-      {
-        "name": "select_variant",
-        "type": "Symbol",
-        "default": "`:single`",
-        "description": "One of `:multiple`, `:none`, or `:single`."
-      },
-      {
-        "name": "fetch_strategy",
-        "type": "Symbol",
-        "default": "`:remote`",
-        "description": "One of `:eventually_local`, `:local`, or `:remote`."
-      },
-      {
-        "name": "no_results_label",
-        "type": "String",
-        "default": "`\"No results found\"`",
-        "description": "The label to display when no results are found."
-      },
-      {
-        "name": "preload",
+        "name": "use_experimental_non_local_form",
         "type": "Boolean",
         "default": "`false`",
-        "description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened."
-      },
-      {
-        "name": "dynamic_label",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether or not to display the text of the currently selected item in the show button."
-      },
-      {
-        "name": "dynamic_label_prefix",
-        "type": "String",
-        "default": "`nil`",
-        "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
-      },
-      {
-        "name": "dynamic_aria_label_prefix",
-        "type": "String",
-        "default": "`nil`",
-        "description": "If provided, the prefix is prepended to the dynamic label and set as the value of the `aria-label` attribute on the show button."
-      },
-      {
-        "name": "body_id",
-        "type": "String",
-        "default": "`nil`",
-        "description": "The unique ID of the panel body. If not provided, the body ID will be set to the panel ID with a \"-body\" suffix."
-      },
-      {
-        "name": "list_arguments",
-        "type": "Hash",
-        "default": "`{}`",
-        "description": "Arguments to pass to the underlying {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}} component. Only has an effect for the local fetch strategy."
-      },
-      {
-        "name": "form_arguments",
-        "type": "Hash",
-        "default": "`{}`",
-        "description": "Form arguments to pass to the underlying {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}} component. Only has an effect for the local fetch strategy."
+        "description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values."
       },
       {
         "name": "show_filter",
@@ -8052,6 +7974,19 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/alpha/select_panel/remote_fetch_form",
+        "name": "remote_fetch_form",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/alpha/select_panel/multiselect_form",
         "name": "multiselect_form",

data/static/previews.json

@@ -6909,6 +6909,19 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/alpha/select_panel/remote_fetch_form",
+        "name": "remote_fetch_form",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/alpha/select_panel/multiselect_form",
         "name": "multiselect_form",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.58.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -905,6 +905,7 @@ files:
 - previews/primer/alpha/select_panel_preview/playground.html.erb
 - previews/primer/alpha/select_panel_preview/remote_fetch.html.erb
 - previews/primer/alpha/select_panel_preview/remote_fetch_filter_failure.html.erb
+- previews/primer/alpha/select_panel_preview/remote_fetch_form.html.erb
 - previews/primer/alpha/select_panel_preview/remote_fetch_initial_failure.html.erb
 - previews/primer/alpha/select_panel_preview/remote_fetch_no_results.html.erb
 - previews/primer/alpha/select_panel_preview/scroll_container.html.erb