hakumi_components 0.1.3.pre

data/sig/hakumi/base_component.rbs

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Hakumi
+  class BaseComponent < ViewComponent::Base
+    # Core class methods
+    def self.inherited: (Class klass) -> void
+
+    # Instance methods
+    # Generate class names with the hakumi- prefix
+    # @param base [String] Base class name (e.g., 'btn', 'icon')
+    # @param modifiers [Hash] Hash of modifier keys and their values (Symbol, String, Integer, or bool)
+    # @param extras [Array<String>] Additional classes to append
+    # @return [String] Combined class string
+    def class_names: (String base, ?Hash[Symbol, (Symbol | String | Integer | bool)] modifiers, ?Array[String] extras) -> String
+
+    # Merge HTML attributes with defaults
+    # @param defaults [Hash] Default attributes
+    # @param overrides [Hash] User-provided attributes
+    # @return [Hash] Merged attributes
+    def merge_attributes: (hakumi_html_options defaults, hakumi_html_options overrides) -> hakumi_html_options
+
+    # Internal helper to check presence without clobbering ActiveSupport#present?
+    # Accepts any value type since it's a generic utility method
+    # @param value [untyped] Value to check
+    # @return [Boolean]
+    def value_present?: (untyped value) -> bool
+
+    # Validate required props
+    # @param props [Array<Symbol>] List of required prop names
+    # @raise [ArgumentError] if any prop is missing
+    def validate_required!: (*Symbol props) -> void
+
+    # Validate prop is one of allowed values
+    # @param prop [Symbol] Prop name
+    # @param allowed [Array] Allowed values (typically Symbol enums, but can include strings/integers)
+    # @raise [ArgumentError] if value is not allowed
+    def validate_inclusion!: (Symbol prop, Array[Symbol | String | Integer | bool] allowed) -> void
+
+    # Ensure attrs has a DOM ID if it has a Stimulus controller
+    # @param attrs [Hash] Attributes hash
+    # @return [void]
+    def ensure_dom_id!: (hakumi_html_options attrs) -> void
+
+    # Generate a unique ID with a prefix
+    # @param prefix [String] Prefix for the ID
+    # @param length [Integer] Length of the random hex (default: 4)
+    # @return [String] Generated ID
+    def generate_id: (String prefix, ?length: Integer) -> String
+
+    # Render a value that can be a String, ViewComponent, or other renderable object
+    # Accepts: String, ActiveSupport::SafeBuffer, ViewComponent, or any object with to_s
+    # @param value [untyped] Value to render (String, ViewComponent, etc.)
+    # @return [String, nil] Rendered value or nil if empty
+    def render_value: (untyped value) -> (String | nil)
+
+    # Convert size string/symbol to integer pixels
+    # Useful for components that accept both symbolic (:small, :large) and numeric sizes
+    # @param size [Symbol, Integer] Size value
+    # @param mapping [Hash] Size to pixel mapping
+    # @return [Integer] Size in pixels
+    def size_to_pixels: ((Symbol | Integer) size, ?Hash[Symbol, Integer] mapping) -> Integer
+
+    # Convert dimension value to CSS string
+    # @param value [Numeric, String, nil] Dimension value
+    # @return [String, nil] CSS dimension string
+    def dimension_to_css: ((Numeric | String | nil) value) -> String?
+
+    # Build inline style string from array or hash
+    # @param styles [Array<String>, Hash] Styles as array of CSS strings or hash of property => value
+    # @return [String, nil] Combined style string
+    def build_inline_style: ((Array[String] | Hash[Symbol | String, (String | Integer | Float)]) styles) -> String?
+
+    private
+
+    def prepare_data_attributes: (hakumi_html_options attrs) -> hakumi_html_options
+  end
+end

data/sig/hakumi/breadcrumb/component.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Breadcrumb
+    class Component < Hakumi::BaseComponent
+      @separator: String
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?separator: String,
+        **hakumi_html_options html_options
+      ) -> void
+
+      attr_reader separator: String
+
+      def breadcrumb_classes: () -> String
+
+      def wrapper_attributes: () -> hakumi_html_options
+    end
+  end
+end

data/sig/hakumi/breadcrumb/item/component.rbs

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Breadcrumb
+    module Item
+      class Component < Hakumi::BaseComponent
+        @title: String?
+        @href: String?
+        @target: String?
+        @menu: Array[untyped]?
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?title: String?,
+          ?href: String?,
+          ?target: String?,
+          ?menu: Array[untyped]?,
+          **hakumi_html_options html_options
+        ) -> void
+
+        attr_reader title: String?
+        attr_reader href: String?
+        attr_reader target: String?
+        attr_reader menu: Array[untyped]?
+
+        def item_classes: () -> String
+
+        def link?: () -> bool
+
+        def menu?: () -> bool
+
+        def display_title: () -> String?
+      end
+    end
+  end
+end

data/sig/hakumi/button/component.rbs

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Button
+    class Component < Hakumi::BaseComponent
+      type button_type = :primary | :default | :dashed | :text | :link
+      type button_size = :small | :middle | :large
+      type button_shape = :default | :circle | :round
+      type html_button_type = :button | :submit | :reset
+
+      TYPES: Array[button_type]
+      SIZES: Array[button_size]
+      SHAPES: Array[button_shape]
+      HTML_TYPES: Array[html_button_type]
+
+      @type: button_type
+      @size: button_size
+      @html_type: html_button_type
+      @href: String?
+      @disabled: bool
+      @loading: bool
+      @danger: bool
+      @block: bool
+      @icon: (String | Symbol | untyped)?
+      @shape: button_shape
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?type: button_type,
+        ?size: button_size,
+        ?html_type: html_button_type,
+        ?href: String?,
+        ?disabled: bool,
+        ?loading: bool,
+        ?danger: bool,
+        ?block: bool,
+        ?icon: (String | Symbol | untyped)?,
+        ?shape: button_shape,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def call: () -> String
+
+      private
+
+      def validate_props!: () -> void
+      def tag_name: () -> Symbol
+      def wrapper_classes: () -> String
+      def wrapper_attributes: () -> hakumi_html_options
+      def content_wrapper: () -> String
+      def icon_element: () -> String?
+      def loading_icon: () -> String
+      def text_element: () -> String?
+    end
+  end
+end

data/sig/hakumi/calendar/component.rbs

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Calendar
+    class Component < Hakumi::BaseComponent
+      type calendar_mode = "month" | "year"
+      type calendar_value = Date | Time | String
+
+      MODES: Array[String]
+
+      @value: calendar_value?
+      @default_value: calendar_value?
+      @mode: calendar_mode
+      @full_screen: bool
+      @disable_date: Proc?
+      @header_render: Proc?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?value: calendar_value?,
+        ?default_value: calendar_value?,
+        ?mode: calendar_mode,
+        ?full_screen: bool,
+        ?disable_date: Proc?,
+        ?header_render: Proc?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def call: () -> String
+
+      private
+
+      def validate_props!: () -> void
+      def wrapper_classes: () -> String
+      def wrapper_attributes: () -> hakumi_html_options
+      def render_header: () -> String
+      def render_body: () -> String
+      def current_date: () -> (Date | Time | String)
+    end
+  end
+end

data/sig/hakumi/card/component.rbs

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Card
+    class Component < Hakumi::BaseComponent
+      type card_size = :default | :small
+      type card_type = :inner | nil
+
+      @title: (String | untyped)?
+      @extra: (String | untyped)?
+      @bordered: bool
+      @hoverable: bool
+      @loading: bool
+      @size: card_size
+      @type: card_type
+      @actions: Array[untyped]
+      @cover: (String | untyped)?
+      @href: String?
+      @target: String?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?title: (String | untyped)?,
+        ?extra: (String | untyped)?,
+        ?bordered: bool,
+        ?hoverable: bool,
+        ?loading: bool,
+        ?size: card_size,
+        ?type: card_type,
+        ?actions: Array[untyped],
+        ?cover: (String | untyped)?,
+        ?href: String?,
+        ?target: String?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      private
+
+      def classes: () -> String
+
+      def head_classes: () -> String
+
+      def body_classes: () -> String
+
+      def render_title: () -> (String | untyped)?
+
+      def render_extra: () -> (String | untyped)?
+    end
+  end
+end

data/sig/hakumi/card/grid/component.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Card
+    module Grid
+      class Component < Hakumi::BaseComponent
+        @hoverable: bool
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?hoverable: bool,
+          **hakumi_html_options html_options
+        ) -> void
+
+        private
+
+        def classes: () -> String
+      end
+    end
+  end
+end

data/sig/hakumi/card/meta/component.rbs

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Card
+    module Meta
+      class Component < Hakumi::BaseComponent
+        @title: (String | untyped)?
+        @description: (String | untyped)?
+        @avatar: (String | untyped)?
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?title: (String | untyped)?,
+          ?description: (String | untyped)?,
+          ?avatar: (String | untyped)?,
+          **hakumi_html_options html_options
+        ) -> void
+
+        private
+
+        def classes: () -> String
+      end
+    end
+  end
+end

data/sig/hakumi/carousel/component.rbs

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Carousel
+    class Component < Hakumi::BaseComponent
+      type carousel_effect = :scrollx | :fade
+      type carousel_dot_placement = :top | :bottom | :start | :end
+
+      EFFECTS: Array[carousel_effect]
+      DOT_PLACEMENTS: Array[carousel_dot_placement]
+
+      @autoplay: bool
+      @autoplay_speed: Integer
+      @dot_placement: carousel_dot_placement
+      @dots: bool
+      @dots_class: String?
+      @arrows: bool
+      @adaptive_height: bool
+      @draggable: bool
+      @infinite: bool
+      @fade: bool
+      @effect: carousel_effect
+      @speed: Integer
+      @easing: String
+      @wait_for_animate: bool
+      @autoplay_dot_duration: bool
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?autoplay: (bool | Hash[Symbol, untyped]),
+        ?autoplay_speed: Integer,
+        ?dot_placement: carousel_dot_placement,
+        ?dots: (bool | Hash[Symbol, untyped]),
+        ?dots_class: String?,
+        ?arrows: bool,
+        ?adaptive_height: bool,
+        ?draggable: bool,
+        ?infinite: bool,
+        ?fade: bool?,
+        ?effect: carousel_effect,
+        ?speed: Integer,
+        ?easing: String,
+        ?wait_for_animate: bool,
+        **hakumi_html_options html_options
+      ) -> void
+
+      attr_reader autoplay: bool
+      attr_reader autoplay_speed: Integer
+      attr_reader dot_placement: carousel_dot_placement
+      attr_reader dots: bool
+      attr_reader dots_class: String?
+      attr_reader arrows: bool
+      attr_reader adaptive_height: bool
+      attr_reader draggable: bool
+      attr_reader infinite: bool
+      attr_reader fade: bool
+      attr_reader effect: carousel_effect
+      attr_reader speed: Integer
+      attr_reader easing: String
+      attr_reader wait_for_animate: bool
+      attr_reader autoplay_dot_duration: bool
+
+      def carousel_classes: () -> String
+
+      def dots?: () -> bool
+
+      def arrows?: () -> bool
+
+      def dots_classes: () -> String
+
+      def slide_classes: (Integer index) -> String
+
+      def dot_classes: (Integer index) -> String
+
+      def stimulus_controller: () -> String
+
+      def stimulus_values: () -> Hash[Symbol, untyped]
+
+      def stimulus_data_attributes: () -> Hash[String, untyped]
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      private
+
+      def validate_props!: () -> void
+    end
+  end
+end

data/sig/hakumi/cascader/component.rbs

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Cascader
+    class Component < Hakumi::BaseComponent
+      type cascader_option = {
+        value: String,
+        label: String,
+        children: Array[cascader_option]?
+      }
+
+      SIZES: Array[hakumi_size_standard]
+      TRIGGERS: Array[hakumi_trigger]
+
+      @name: String
+      @options: Array[Hash[Symbol, untyped]]
+      @value: Array[String | Integer | Float]
+      @placeholder: String
+      @size: hakumi_size_standard
+      @disabled: bool
+      @allow_clear: bool
+      @show_search: bool
+      @change_on_select: bool
+      @expand_trigger: hakumi_trigger
+      @display_render: Proc?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?name: String?,
+        ?options: Array[Hash[Symbol, untyped]],
+        ?value: Array[String | Integer | Float],
+        ?placeholder: String,
+        ?size: hakumi_size_standard,
+        ?disabled: bool,
+        ?allow_clear: bool,
+        ?show_search: bool,
+        ?change_on_select: bool,
+        ?expand_trigger: hakumi_trigger,
+        ?display_render: Proc?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def validate_props!: () -> void
+
+      def wrapper_classes: () -> String
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      def selected_label: () -> String?
+    end
+  end
+end

data/sig/hakumi/checkbox/component.rbs

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Checkbox
+    class Component < Hakumi::BaseComponent
+      @checked: bool
+      @disabled: bool
+      @indeterminate: bool
+      @value: (String | Integer | Float)?
+      @name: String?
+      @id: String
+      @auto_focus: bool
+      @label: String?
+      @wrapper_id: String
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?checked: bool,
+        ?disabled: bool,
+        ?indeterminate: bool,
+        ?value: (String | Integer | Float)?,
+        ?name: String?,
+        ?id: String?,
+        ?auto_focus: bool,
+        ?label: String?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def wrapper_classes: () -> String
+
+      def checkbox_classes: () -> String
+
+      def data_controllers: () -> String
+    end
+  end
+end

data/sig/hakumi/checkbox/group/component.rbs

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Checkbox
+    module Group
+      class Component < Hakumi::BaseComponent
+        type checkbox_option = { label: String, value: (String | Integer | Float) }
+
+        @name: String
+        @value: Array[String | Integer | Float]
+        @options: Array[Hash[Symbol, untyped] | String]
+        @disabled: bool
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?name: String?,
+          ?value: Array[String | Integer | Float],
+          ?default_value: Array[String | Integer | Float],
+          ?options: Array[Hash[Symbol, untyped] | String],
+          ?disabled: bool,
+          **hakumi_html_options html_options
+        ) -> void
+
+        def wrapper_classes: () -> String
+
+        def wrapper_attributes: () -> hakumi_html_options
+
+        def normalized_options: () -> Array[checkbox_option]
+
+        def option_checked?: ((String | Integer | Float) option_value) -> bool
+      end
+    end
+  end
+end

data/sig/hakumi/collapse/component.rbs

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Collapse
+    class Component < Hakumi::BaseComponent
+      type collapse_size = :default | :small | :large
+      type collapse_collapsible = :header | :icon | :disabled | nil
+
+      SIZES: Array[collapse_size]
+      COLLAPSIBLES: Array[collapse_collapsible]
+
+      @size: collapse_size
+      @accordion: bool
+      @bordered: bool
+      @ghost: bool
+      @collapsible: collapse_collapsible
+      @active_keys: Array[String]?
+      @default_active_keys: Array[String]?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?size: collapse_size,
+        ?accordion: bool,
+        ?bordered: bool,
+        ?ghost: bool,
+        ?collapsible: collapse_collapsible,
+        ?active_keys: (String | Array[String] | nil)?,
+        ?default_active_keys: (String | Array[String] | nil)?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      attr_reader size: collapse_size
+      attr_reader accordion: bool
+      attr_reader bordered: bool
+      attr_reader ghost: bool
+      attr_reader collapsible: collapse_collapsible
+
+      def collapse_classes: () -> String
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      def stimulus_controller: () -> String
+
+      def initial_active_keys: () -> Array[String]
+
+      def stimulus_values: () -> Hash[Symbol, untyped]
+
+      def stimulus_data_attributes: () -> Hash[String, untyped]
+
+      private
+
+      def normalize_keys: ((String | Array[String] | nil)?) -> Array[String]?
+
+      def validate_props!: () -> void
+    end
+  end
+end

data/sig/hakumi/collapse/panel/component.rbs

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Collapse
+    module Panel
+      class Component < Hakumi::BaseComponent
+        type panel_collapsible = :header | :icon | :disabled | nil
+
+        @key: String
+        @header: (String | untyped)?
+        @extra: (String | untyped)?
+        @disabled: bool
+        @show_arrow: bool
+        @collapsible: panel_collapsible
+        @force_render: bool
+        @parent: Hakumi::Collapse::Component?
+        @html_options: hakumi_html_options
+        @content: (String | untyped)?
+
+        def initialize: (
+          key: (String | Symbol | Integer),
+          ?header: (String | untyped)?,
+          ?extra: (String | untyped)?,
+          ?disabled: bool,
+          ?show_arrow: bool,
+          ?collapsible: panel_collapsible,
+          ?force_render: bool,
+          ?parent: Hakumi::Collapse::Component?,
+          **hakumi_html_options html_options
+        ) -> void
+
+        attr_reader key: String
+        attr_reader header: (String | untyped)?
+        attr_reader extra: (String | untyped)?
+        attr_reader disabled: bool
+        attr_reader show_arrow: bool
+        attr_reader collapsible: panel_collapsible
+        attr_reader force_render: bool
+        attr_accessor content: (String | untyped)?
+
+        def item_classes: (bool active) -> String
+
+        def item_attributes: (bool active) -> hakumi_html_options
+      end
+    end
+  end
+end