openproject-primer_view_components 0.6.3

data/app/components/primer/anchored_position.ts

@@ -0,0 +1,153 @@
+import type {AnchorAlignment, AnchorSide, PositionSettings} from '@primer/behaviors'
+import {getAnchoredPosition} from '@primer/behaviors'
+
+const updateWhenVisible = (() => {
+  const anchors = new Set<AnchoredPositionElement>()
+  let intersectionObserver: IntersectionObserver | null = null
+  let resizeObserver: ResizeObserver | null = null
+  function updateVisibleAnchors() {
+    for (const anchor of anchors) {
+      anchor.update()
+    }
+  }
+  return (el: AnchoredPositionElement) => {
+    // eslint-disable-next-line github/prefer-observers
+    window.addEventListener('resize', updateVisibleAnchors)
+    intersectionObserver ||= new IntersectionObserver(entries => {
+      for (const entry of entries) {
+        const target = entry.target as AnchoredPositionElement
+        if (entry.isIntersecting) {
+          target.update()
+          anchors.add(target)
+        } else {
+          anchors.delete(target)
+        }
+      }
+    })
+    resizeObserver ||= new ResizeObserver(() => {
+      for (const anchor of anchors) {
+        anchor.update()
+      }
+    })
+    resizeObserver.observe(el.ownerDocument.documentElement)
+    intersectionObserver.observe(el)
+  }
+})()
+
+export default class AnchoredPositionElement extends HTMLElement implements PositionSettings {
+  get align(): AnchorAlignment {
+    const value = this.getAttribute('align')
+    if (value === 'center' || value === 'end') return value
+    return 'start'
+  }
+
+  set align(value: AnchorAlignment) {
+    this.setAttribute('align', `${value}`)
+  }
+
+  get side(): AnchorSide {
+    const value = this.getAttribute('side')
+    if (
+      value === 'inside-top' ||
+      value === 'inside-bottom' ||
+      value === 'inside-left' ||
+      value === 'inside-right' ||
+      value === 'inside-center' ||
+      value === 'outside-top' ||
+      value === 'outside-left' ||
+      value === 'outside-right'
+    ) {
+      return value
+    }
+    return 'outside-bottom'
+  }
+
+  set side(value: AnchorSide) {
+    this.setAttribute('side', `${value}`)
+  }
+
+  get anchorOffset(): number {
+    const alias = this.getAttribute('anchor-offset')
+    if (alias === 'spacious' || alias === '8') return 8
+    return 4
+  }
+
+  set anchorOffset(value: number | 'normal' | 'spacious') {
+    this.setAttribute('anchor-offset', `${value}`)
+  }
+
+  get anchor() {
+    return this.getAttribute('anchor') || ''
+  }
+
+  set anchor(value: string) {
+    this.setAttribute('anchor', `${value}`)
+  }
+
+  #anchorElement: HTMLElement | null = null
+  get anchorElement(): HTMLElement | null {
+    if (this.#anchorElement) return this.#anchorElement
+    const idRef = this.anchor
+    if (!idRef) return null
+    return this.ownerDocument.getElementById(idRef)
+  }
+
+  set anchorElement(value: HTMLElement | null) {
+    this.#anchorElement = value
+    if (!this.#anchorElement) {
+      this.removeAttribute('anchor')
+    }
+  }
+
+  get alignmentOffset(): number {
+    return Number(this.getAttribute('alignment-offset'))
+  }
+
+  set alignmentOffset(value: number) {
+    this.setAttribute('alignment-offset', `${value}`)
+  }
+
+  get allowOutOfBounds() {
+    return this.hasAttribute('allow-out-of-bounds')
+  }
+
+  set allowOutOfBounds(value: boolean) {
+    this.toggleAttribute('allow-out-of-bounds', value)
+  }
+
+  connectedCallback() {
+    this.update()
+    this.addEventListener('beforetoggle', () => this.update())
+    updateWhenVisible(this)
+  }
+
+  static observedAttributes = ['align', 'side', 'anchor', 'alignment-offset', 'allow-out-of-bounds']
+  attributeChangedCallback() {
+    this.update()
+  }
+
+  #animationFrame: ReturnType<typeof requestAnimationFrame>
+  update() {
+    if (!this.isConnected) return
+    cancelAnimationFrame(this.#animationFrame)
+
+    this.#animationFrame = requestAnimationFrame(() => {
+      const anchor = this.anchorElement
+      if (!anchor) return
+      const {left, top} = getAnchoredPosition(this, anchor, this)
+      this.style.top = `${top}px`
+      this.style.left = `${left}px`
+    })
+  }
+}
+
+if (!customElements.get('anchored-position')) {
+  window.AnchoredPositionElement = AnchoredPositionElement
+  customElements.define('anchored-position', AnchoredPositionElement)
+}
+
+declare global {
+  interface Window {
+    AnchoredPositionElement: typeof AnchoredPositionElement
+  }
+}

data/app/components/primer/base_component.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "primer/classify"
+
+module Primer
+  # All Primer ViewComponents accept a standard set of options called system arguments, mimicking the [styled-system API](https://styled-system.com/table) used by [Primer React](https://primer.style/components/system-props).
+  #
+  # Under the hood, system arguments are [mapped](https://github.com/primer/view_components/blob/main/lib/primer/classify.rb) to Primer CSS classes, with any remaining options passed to Rails' [`content_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag).
+  #
+  # ## Responsive values
+  #
+  # To apply different values across responsive breakpoints, pass an array with up to five values in the order `[default, small, medium, large, xlarge]`. To skip a breakpoint, pass `nil`.
+  #
+  # For example:
+  #
+  # ```erb
+  # <%= render Primer::Beta::Heading.new(mt: [0, nil, nil, 4, 2]) do %>
+  #   Hello world
+  # <% end %>
+  # ```
+  #
+  # Renders:
+  #
+  # ```html
+  # <h1 class="mt-0 mt-lg-4 mt-xl-2">Hello world</h1>
+  # ```
+  class BaseComponent < Primer::Component
+    status :beta
+
+    SELF_CLOSING_TAGS = [:area, :base, :br, :col, :embed, :hr, :img, :input, :link, :meta, :param, :source, :track, :wbr].freeze
+    # ## HTML attributes
+    #
+    # System arguments include most HTML attributes. For example:
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `aria` | `Hash` | Aria attributes: `aria: { label: "foo" }` renders `aria-label='foo'`. |
+    # | `data` | `Hash` | Data attributes: `data: { foo: :bar }` renders `data-foo='bar'`. |
+    # | `height` | `Integer` | Height. |
+    # | `hidden` | `Boolean` | Whether to assign the `hidden` attribute. |
+    # | `style` | `String` | Inline styles. |
+    # | `title` | `String` | The `title` attribute. |
+    # | `width` | `Integer` | Width. |
+    #
+    # ## Animation
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `animation` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:animation)) %> |
+    #
+    # ## Border
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `border_bottom` | Integer | Set to `0` to remove the bottom border. |
+    # | `border_left` | Integer | Set to `0` to remove the left border. |
+    # | `border_radius` | Integer | <%= one_of([0, 1, 2, 3]) %> |
+    # | `border_right` | Integer | Set to `0` to remove the right border. |
+    # | `border_top` | Integer | Set to `0` to remove the top border. |
+    # | `border` | Symbol | <%= one_of([:left, :top, :bottom, :right, :y, :x, true]) %> |
+    # | `box_shadow` | Boolean, Symbol | Box shadow. <%= one_of([true, :medium, :large, :extra_large, :none]) %> |
+    #
+    # ## Color
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `bg` | Symbol | Background color. <%= one_of(Primer::Classify::Utilities.mappings(:bg)) %> |
+    # | `border_color` | Symbol | Border color. <%= one_of(Primer::Classify::Utilities.mappings(:border_color)) %> |
+    # | `color` | Symbol | Text color. <%= one_of(Primer::Classify::Utilities.mappings(:color)) %> |
+    #
+    # ## Flex
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `align_items` | Symbol | <%= one_of(Primer::Classify::FLEX_ALIGN_ITEMS_VALUES) %> |
+    # | `align_self` | Symbol | <%= one_of(Primer::Classify::FLEX_ALIGN_SELF_VALUES) %> |
+    # | `direction` | Symbol | <%= one_of(Primer::Classify::FLEX_DIRECTION_VALUES) %> |
+    # | `flex` | Integer, Symbol | <%= one_of(Primer::Classify::FLEX_VALUES) %> |
+    # | `flex_grow` | Integer | To enable, set to `0`. |
+    # | `flex_shrink` | Integer | To enable, set to `0`. |
+    # | `flex_wrap` | Symbol | <%= one_of(Primer::Classify::FLEX_WRAP_MAPPINGS.keys) %> |
+    # | `justify_content` | Symbol | <%= one_of(Primer::Classify::FLEX_JUSTIFY_CONTENT_VALUES) %> |
+    #
+    # ## Grid
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `clearfix` | Boolean | Whether to assign the `clearfix` class. |
+    # | `col` | Integer | Number of columns. <%= one_of(Primer::Classify::Utilities.mappings(:col)) %> |
+    # | `container` | Symbol | Size of the container. <%= one_of(Primer::Classify::Utilities.mappings(:container)) %> |
+    #
+    # ## Layout
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `display` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:display)) %> |
+    # | `w` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:w)) %> |
+    # | `h` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:h)) %> |
+    # | `hide` | Symbol | Hide the element at a specific breakpoint. <%= one_of(Primer::Classify::Utilities.mappings(:hide)) %> |
+    # | `visibility` | Symbol | Visibility. <%= one_of(Primer::Classify::Utilities.mappings(:visibility)) %> |
+    # | `vertical_align` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:vertical_align)) %> |
+    #
+    # ## Position
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `bottom` | Boolean | If `false`, sets `bottom: 0`. |
+    # | `float` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:float)) %> |
+    # | `left` | Boolean | If `false`, sets `left: 0`. |
+    # | `position` | Symbol | <%= one_of(Primer::Classify::Utilities.mappings(:position)) %> |
+    # | `right` | Boolean | If `false`, sets `right: 0`. |
+    # | `top` | Boolean | If `false`, sets `top: 0`. |
+    #
+    # ## Spacing
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `m` | Integer | Margin. <%= one_of(Primer::Classify::Utilities.mappings(:m)) %> |
+    # | `mb` | Integer | Margin bottom. <%= one_of(Primer::Classify::Utilities.mappings(:mb)) %> |
+    # | `ml` | Integer | Margin left. <%= one_of(Primer::Classify::Utilities.mappings(:ml)) %> |
+    # | `mr` | Integer | Margin right. <%= one_of(Primer::Classify::Utilities.mappings(:mr)) %> |
+    # | `mt` | Integer | Margin top. <%= one_of(Primer::Classify::Utilities.mappings(:mt)) %> |
+    # | `mx` | Integer | Horizontal margins. <%= one_of(Primer::Classify::Utilities.mappings(:mx)) %> |
+    # | `my` | Integer | Vertical margins. <%= one_of(Primer::Classify::Utilities.mappings(:my)) %> |
+    # | `p` | Integer | Padding. <%= one_of(Primer::Classify::Utilities.mappings(:p)) %> |
+    # | `pb` | Integer | Padding bottom. <%= one_of(Primer::Classify::Utilities.mappings(:pb)) %> |
+    # | `pl` | Integer | Padding left. <%= one_of(Primer::Classify::Utilities.mappings(:pl)) %> |
+    # | `pr` | Integer | Padding right. <%= one_of(Primer::Classify::Utilities.mappings(:pr)) %> |
+    # | `pt` | Integer | Padding left. <%= one_of(Primer::Classify::Utilities.mappings(:pt)) %> |
+    # | `px` | Integer | Horizontal padding. <%= one_of(Primer::Classify::Utilities.mappings(:px)) %> |
+    # | `py` | Integer | Vertical padding. <%= one_of(Primer::Classify::Utilities.mappings(:py)) %> |
+    #
+    # ## Typography
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | `font_family` | Symbol | Font family. <%= one_of([:mono]) %> |
+    # | `font_size` | String, Integer, Symbol | <%= one_of(["00", 0, 1, 2, 3, 4, 5, 6, :small, :normal]) %> |
+    # | `font_style` | Symbol | Font style. <%= one_of([:italic]) %> |
+    # | `font_weight` | Symbol | Font weight. <%= one_of([:light, :normal, :bold, :emphasized]) %> |
+    # | `text_align` | Symbol | Text alignment. <%= one_of([:left, :right, :center]) %> |
+    # | `text_transform` | Symbol | Text transformation. <%= one_of([:uppercase, :capitalize]) %> |
+    # | `underline` | Boolean | Whether text should be underlined. |
+    # | `word_break` | Symbol | Whether to break words on line breaks. <%= one_of(Primer::Classify::Utilities.mappings(:word_break)) %> |
+    #
+    # ## Other
+    #
+    # | Name | Type | Description |
+    # | :- | :- | :- |
+    # | classes | String | CSS class name value to be concatenated with generated Primer CSS classes. |
+    # | test_selector | String | Adds `data-test-selector='given value'` in non-Production environments for testing purposes. |
+    def initialize(tag:, classes: nil, **system_arguments)
+      @tag = tag
+
+      @system_arguments = validate_arguments(tag: tag, **system_arguments)
+
+      @result = Primer::Classify.call(**@system_arguments.merge(classes: classes))
+
+      @system_arguments[:"data-view-component"] = true
+      # Filter out Primer keys so they don't get assigned as HTML attributes
+      @content_tag_args = add_test_selector(@system_arguments).except(*Primer::Classify::Utilities::UTILITIES.keys)
+    end
+
+    def call
+      if SELF_CLOSING_TAGS.include?(@tag)
+        tag(@tag, @content_tag_args.merge(@result))
+      else
+        content_tag(@tag, content, @content_tag_args.merge(@result))
+      end
+    end
+  end
+end

data/app/components/primer/beta/auto_complete/auto_complete.d.ts

@@ -0,0 +1 @@
+import '@github/auto-complete-element';

data/app/components/primer/beta/auto_complete/auto_complete.html.erb

@@ -0,0 +1,28 @@
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <div class="<%= @form_group_classes %>">
+    <label for="<%= @input_id %>" class="FormControl-label <% if @visually_hide_label %>sr-only<% end %>">
+      <%= @label_text %>
+    </label>
+    <% if leading_visual || @show_clear_button %>
+        <div class="<%= @field_wrap_classes %> <% if leading_visual %>FormControl-input-wrap--leadingVisual<% end %>">
+            <span class="FormControl-input-leadingVisualWrap">
+                <%= leading_visual %>
+            </span>
+            <%= input %>
+            <% if @show_clear_button %>
+              <button id="<%= @input_id %>-clear" class="FormControl-input-trailingAction" aria-label="Clear"><%= primer_octicon "x-circle-fill" %></button>
+            <% end %>
+        </div>
+    <% else %>
+      <%= input %>
+    <% end %>
+  </div>
+  <div class="Overlay-backdrop--anchor">
+    <div class="<%= @overlay_classes %>">
+      <div class="Overlay-body Overlay-body--paddingNone">
+        <%= results %>
+      </div>
+    </div>
+  </div>
+  <div id="<%= @list_id %>-feedback" class="sr-only"></div>
+<% end %>

data/app/components/primer/beta/auto_complete/auto_complete.js

@@ -0,0 +1 @@
+import '@github/auto-complete-element';

data/app/components/primer/beta/auto_complete/auto_complete.ts

@@ -0,0 +1 @@
+import '@github/auto-complete-element'

data/app/components/primer/beta/auto_complete/item.html.erb

@@ -0,0 +1,21 @@
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <span class="ActionListContent">
+    <% if leading_visual %>
+        <span class="ActionListItem-visual ActionListItem-visual--leading">
+            <%= leading_visual %>
+        </span>
+    <% end %>
+    <%= render(Primer::ConditionalWrapper.new(condition: description?, tag: :span, **@description_wrapper_arguments)) do %>
+      <span class="ActionListItem-label"><%= content %></span>
+      <% if description? %>
+        <span class="ActionListItem-description">
+          <%= description %>
+        </span>
+      <% end %>
+    <% end %>
+   <% if trailing_visual %>
+        <span class="ActionListItem-visual ActionListItem-visual--trailing">
+            <%= trailing_visual %>
+        </span>
+    <% end %>
+<% end %>

data/app/components/primer/beta/auto_complete/item.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# TODO: use generic ActionList item for Autocomplete
+module Primer
+  module Beta
+    class AutoComplete
+      # Use `AutoCompleteItem` to list results of an auto-completed search.
+      class Item < Primer::Component
+        status :beta
+
+        DEFAULT_DESCRIPTION_VARIANT = :block
+        DESCRIPTION_VARIANT_MAPPINGS = {
+          :inline => "ActionListItem-descriptionWrap--inline",
+          DEFAULT_DESCRIPTION_VARIANT => "ActionListItem-descriptionWrap"
+        }.freeze
+        DESCRIPTION_VARIANT_OPTIONS = DESCRIPTION_VARIANT_MAPPINGS.keys.freeze
+
+        # The leading visual rendered before the link.
+        #
+        # @param kwargs [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::Avatar) %> or <%= link_to_component(Primer::Beta::Octicon) %>
+        renders_one :leading_visual, types: {
+          icon: Primer::Beta::Octicon,
+          avatar: lambda { |**kwargs|
+            Primer::Beta::Avatar.new(**{ **kwargs, size: 16 })
+          }
+        }
+
+        # The trailing visual rendered after the link.
+        #
+        # @param kwargs [Hash] The arguments accepted by <%= link_to_component(Primer::Beta::Octicon) %>, <%= link_to_component(Primer::Beta::Label) %>, or <%= link_to_component(Primer::Beta::Counter) %>
+        renders_one :trailing_visual, types: {
+          icon: Primer::Beta::Octicon,
+          label: Primer::Beta::Label,
+          counter: Primer::Beta::Counter
+        }
+
+        # Optional description
+        #
+        # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+        renders_one :description
+
+        # @example Default
+        #   <%= render(Primer::Beta::AutoComplete::Item.new(selected: true, value: "value")) do %>
+        #     Selected
+        #   <% end %>
+        #   <%= render(Primer::Beta::AutoComplete::Item.new(value: "value")) do %>
+        #     Not selected
+        #   <% end %>
+        #
+        # @param value [String] Value of the item.
+        # @param selected [Boolean] Whether the item is selected.
+        # @param disabled [Boolean] Whether the item is disabled.
+        # @param description_variant [Hash] Changes the description style. Allowed values are :inline, :block
+        # @param description [String] Display description text below label
+        # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+        def initialize(value:, selected: false, disabled: false, description_variant: DEFAULT_DESCRIPTION_VARIANT, **system_arguments)
+          @description_variant = fetch_or_fallback(
+            DESCRIPTION_VARIANT_OPTIONS, description_variant, DEFAULT_DESCRIPTION_VARIANT
+          )
+
+          @system_arguments = deny_tag_argument(**system_arguments)
+          @system_arguments[:tag] = :li
+          @system_arguments[:role] = :option
+          @system_arguments[:"data-autocomplete-value"] = value
+
+          @system_arguments[:"aria-selected"] = true if selected
+          @system_arguments[:"aria-disabled"] = true if disabled
+
+          @system_arguments[:classes] = class_names(
+            "ActionListItem",
+            system_arguments[:classes]
+          )
+
+          @description_wrapper_arguments = {
+            classes: class_names(
+              "ActionListItem-descriptionWrap",
+              DESCRIPTION_VARIANT_MAPPINGS[@description_variant]
+            )
+          }
+        end
+      end
+    end
+  end
+end