Sha256: dff2d7060b295c2d0fb7a72a9d1e9b4ae6bd2d207b20319ec75363d306d84414

Contents?: true

Size: 1.26 KB

Versions: 142

Compression:

Stored size: 1.26 KB

Contents

# frozen_string_literal: true

module Primer
  module Alpha
    Select = Primer::FormComponents.from_input(Primer::Forms::Dsl::SelectInput)

    # Select lists are single-line text inputs rendered as `<select>` tags in HTML.
    #
    # @form_usage
    #   class ExampleForm < ApplicationForm
    #     form do |example_form|
    #       example_form.select_list(attributes) do |list|
    #         list.option(option_attributes)
    #       end
    #     end
    #   end
    class Select < Primer::Component
      status :alpha

      # @!method initialize
      #
      # @macro form_size_arguments
      # @macro form_input_arguments
      #
      # @param multiple [Boolean] If set to true, the selection will allow multiple choices.
      # @param include_blank [Boolean, String] If set to true, an empty option will be created. If set to a string, the string will be used as the option's content and the value will be empty.
      # @param prompt [String] Create a prompt option with blank value and the text asking user to select something.

      # @!method option
      #
      # Adds an option to the list.
      #
      # @param label [String] The user-facing label for the option.
      # @param value [String] The value sent to the server on form submission.
    end
  end
end

Version data entries

142 entries across 142 versions & 2 rubygems

Version Path
primer_view_components-0.20.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.23.0 app/components/primer/alpha/select.rb
primer_view_components-0.19.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.22.2 app/components/primer/alpha/select.rb
primer_view_components-0.18.2 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.22.1 app/components/primer/alpha/select.rb
primer_view_components-0.18.1 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.22.0 app/components/primer/alpha/select.rb
primer_view_components-0.18.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.21.0 app/components/primer/alpha/select.rb
primer_view_components-0.17.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.20.0 app/components/primer/alpha/select.rb
primer_view_components-0.16.1 app/components/primer/alpha/select.rb
primer_view_components-0.16.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.19.0 app/components/primer/alpha/select.rb
primer_view_components-0.15.1 app/components/primer/alpha/select.rb
primer_view_components-0.15.0 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.18.1 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.17.1 app/components/primer/alpha/select.rb
openproject-primer_view_components-0.17.0 app/components/primer/alpha/select.rb