hakumi_components 0.1.3.pre

data/sig/hakumi/slider/component.rbs

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Slider
+    class Component < Hakumi::BaseComponent
+      include Hakumi::Concerns::FormField
+
+      type numeric_or_string = Numeric | String
+      type slider_value = numeric_or_string | Array[numeric_or_string]
+      type mark_entry = { value: numeric_or_string, label: numeric_or_string }
+      type marks_hash = Hash[numeric_or_string, String]
+      type marks_array = Array[mark_entry | numeric_or_string]
+      type marks_input = marks_hash | marks_array
+
+      @name: String
+      @label: String?
+      @caption: String?
+      @value: slider_value?
+      @default_value: slider_value?
+      @min: numeric_or_string
+      @max: numeric_or_string
+      @step: numeric_or_string
+      @range: bool
+      @vertical: bool
+      @marks: Array[mark_entry]
+      @dots: bool
+      @tooltip_visible: bool?
+      @keyboard: bool
+      @disabled: bool
+      @allow_cross: bool
+      @handle_min: (numeric_or_string | Array[numeric_or_string])?
+      @handle_max: (numeric_or_string | Array[numeric_or_string])?
+      @standalone: bool
+      @required: bool
+      @errors: Array[String]
+      @html_attrs: hakumi_html_options
+
+      def initialize: (
+        ?name: String?,
+        ?label: String?,
+        ?caption: String?,
+        ?value: slider_value?,
+        ?default_value: slider_value?,
+        ?min: numeric_or_string,
+        ?max: numeric_or_string,
+        ?step: numeric_or_string,
+        ?range: bool,
+        ?vertical: bool,
+        ?marks: marks_input?,
+        ?dots: bool,
+        ?tooltip_visible: bool?,
+        ?keyboard: bool,
+        ?disabled: bool,
+        ?allow_cross: bool,
+        ?handle_min: (numeric_or_string | Array[numeric_or_string])?,
+        ?handle_max: (numeric_or_string | Array[numeric_or_string])?,
+        ?standalone: bool,
+        ?required: bool,
+        ?errors: (Array[String] | String),
+        **hakumi_html_options html_attrs
+      ) -> void
+
+      def wrapper_attributes: () -> hakumi_html_options
+      def input_name: () -> String
+      def input_id_for: (Integer index) -> String
+      def handle_count: () -> Integer
+      def marks?: () -> bool
+      def mark_style: (numeric_or_string value) -> String
+      def dot_values: () -> Array[numeric_or_string]
+
+      private
+
+      def validate_props!: () -> void
+      def validate_numeric_like!: (untyped value, String name) -> void
+      def validate_range_values!: (untyped value, String name) -> void
+      def component_html_class: () -> String
+      def tooltip_visible_class?: () -> bool
+      def tooltip_visible_value: () -> bool?
+      def data_value: (slider_value? value) -> String?
+      def handle_bounds_value: ((numeric_or_string | Array[numeric_or_string])? value) -> String?
+      def normalize_marks: (marks_input? marks) -> Array[Hash[Symbol, numeric_or_string]]
+      def position_percent: (numeric_or_string value) -> Numeric
+      def cast_boolean: (untyped value) -> bool
+    end
+  end
+end

data/sig/hakumi/space/compact/component.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Space
+    module Compact
+      class Component < ViewComponent::Base
+        @direction: Symbol
+        @block: bool
+        @html_options: hakumi_html_options
+
+        def initialize: (?direction: Symbol, ?block: bool, **hakumi_html_options html_options) -> void
+
+        private
+
+        def html_attributes: () -> hakumi_html_options
+        def css_classes: () -> String
+        def inline_styles: () -> String
+      end
+    end
+  end
+end

data/sig/hakumi/space/component.rbs

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Space
+    class Component < ViewComponent::Base
+      type space_direction = :horizontal | :vertical
+      type space_size = :small | :middle | :large | Integer
+      type space_align = :start | :center | :end | :baseline | :stretch
+
+      @direction: space_direction
+      @size: space_size
+      @align: space_align?
+      @wrap: bool
+      @block: bool
+      @split: untyped
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?direction: space_direction,
+        ?size: space_size,
+        ?align: space_align?,
+        ?wrap: bool,
+        ?block: bool,
+        ?split: untyped,
+        **hakumi_html_options html_options
+      ) -> void
+
+      attr_reader split: untyped
+
+      private
+
+      def html_attributes: () -> hakumi_html_options
+
+      def css_classes: () -> String
+
+      def inline_styles: () -> String
+
+      def call: () -> String?
+
+      def split_content: () -> String?
+
+      class ItemComponent < ViewComponent::Base
+        def call: () -> String
+      end
+    end
+  end
+end

data/sig/hakumi/spin/component.rbs

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Spin
+    class Component < Hakumi::BaseComponent
+      type spin_size = :small | :default | :large
+      type spin_percent = Numeric | :auto
+
+      SIZES: Array[spin_size]
+
+      # Extracts locals from controller params for dynamic rendering
+      def self.extract_controller_locals: (untyped params) -> Hash[Symbol, untyped]
+
+      def self.parse_delay: (untyped value) -> Numeric?
+
+      def self.parse_percent: (untyped value) -> (Numeric | :auto)?
+
+      @spinning: bool
+      @size: spin_size
+      @tip: String?
+      @delay: Numeric | String | nil
+      @indicator: untyped
+      @fullscreen: bool
+      @percent: spin_percent?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?spinning: bool,
+        ?size: spin_size?,
+        ?tip: String?,
+        ?delay: Numeric | String | nil,
+        ?indicator: untyped,
+        ?fullscreen: bool,
+        ?percent: spin_percent?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      def nested?: () -> bool
+
+      def indicator_markup: () -> String?
+
+      def tip_markup: () -> String?
+
+      def show_text?: () -> bool
+
+      def progress?: () -> bool
+
+      def progress_auto?: () -> bool
+
+      def progress_component: () -> untyped
+
+      private
+
+      def validate_props!: () -> void
+
+      def wrapper_classes: () -> String
+
+      def data_attributes: () -> hakumi_html_options
+
+      def normalized_delay: () -> (Numeric | String | nil)
+
+      def percent_value: () -> (Numeric | :auto | String | nil)?
+
+      def spinning_class?: () -> bool
+
+      def progress_indicator: () -> String
+
+      def default_indicator: () -> String
+
+      def normalize_percent: (untyped value) -> spin_percent?
+
+      def progress_size: () -> Integer
+    end
+  end
+end

data/sig/hakumi/splitter/component.rbs

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Splitter
+    class Component < Hakumi::BaseComponent
+      type splitter_layout = :horizontal | :vertical
+
+      @layout: splitter_layout
+      @resizable: bool
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?layout: splitter_layout,
+        ?resizable: bool,
+        **hakumi_html_options html_options
+      ) -> void
+
+      private
+
+      def html_attributes: () -> hakumi_html_options
+
+      def css_classes: () -> String
+
+      def inline_styles: () -> String
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Splitter
+    module Panel
+      class Component < ViewComponent::Base
+        @size: (Integer | String)?
+        @min: (Integer | String)?
+        @max: (Integer | String)?
+        @resizable: bool
+        # collapsible can be bool or hash config that gets JSON stringified
+        @collapsible: (bool | Hash[Symbol, untyped])
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?size: (Integer | String)?,
+          ?min: (Integer | String)?,
+          ?max: (Integer | String)?,
+          ?resizable: bool,
+          # collapsible can be bool or hash with arbitrary config options
+          ?collapsible: (bool | Hash[Symbol, untyped]),
+          **hakumi_html_options html_options
+        ) -> void
+
+        private
+
+        def html_attributes: () -> hakumi_html_options
+        def css_classes: () -> String
+        def inline_styles: () -> String
+        def collapsible_config: () -> String
+        def horizontal_layout?: () -> bool
+        def vertical_layout?: () -> bool
+      end
+    end
+  end
+end

data/sig/hakumi/statistic/component.rbs

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Statistic
+    class Component < Hakumi::BaseComponent
+      include ActionView::Helpers::NumberHelper
+
+      DEFAULT_DURATION: Integer
+      DEFAULT_COUNTDOWN_FORMAT: String
+
+      @title: untyped
+      @value: untyped
+      @precision: Integer?
+      @prefix: untyped
+      @suffix: untyped
+      @animated: bool
+      @duration: (Integer | Float)
+      @countdown: bool
+      @format: String?
+      @aria_label: String?
+      @html_options: hakumi_html_options
+      @numeric_value: (Integer | Float)?
+
+      def self.extract_controller_locals: (untyped params) -> Hash[Symbol, untyped]
+
+      def self.parse_value_param: (untyped value) -> (Numeric | untyped)?
+
+      def self.parse_number: (untyped value) -> Numeric?
+
+      def self.parse_integer: (untyped value) -> Integer?
+
+      def self.truthy_param?: (untyped value) -> bool
+
+      def initialize: (
+        ?title: untyped,
+        ?value: untyped,
+        ?precision: Integer?,
+        ?prefix: untyped,
+        ?suffix: untyped,
+        ?animated: bool,
+        ?duration: (Integer | Float),
+        ?countdown: bool,
+        ?format: String?,
+        ?aria_label: String?,
+        **hakumi_html_options html_options
+      ) -> void
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      def title_content: () -> untyped
+
+      def prefix_content: () -> untyped
+
+      def suffix_content: () -> untyped
+
+      def display_value: () -> String?
+
+      def countdown?: () -> bool
+
+      def animated?: () -> bool
+
+      def countdown_target_timestamp: () -> Integer?
+
+      def countdown_format: () -> String?
+
+      def numeric_value: () -> (Integer | Float)?
+
+      private
+
+      def validate_props!: () -> void
+
+      def wrapper_classes: () -> String
+
+      def data_attributes: () -> hakumi_html_options
+
+      def formatted_numeric_value: () -> String
+
+      def formatted_countdown_value: () -> String
+
+      def countdown_remaining_ms: () -> Integer
+
+      def numeric_value?: () -> (Integer | Float | bool | nil)
+
+      def normalize_countdown_target: (untyped value) -> Time?
+
+      def format_duration: ((Integer | Float) milliseconds, String format) -> String
+
+      def cast_boolean: (untyped value) -> bool
+
+      def normalize_precision: (untyped value) -> Integer?
+
+      def normalize_duration: (untyped value) -> Numeric
+
+      def normalize_format: (untyped value) -> String?
+
+      def normalize_string: (untyped value) -> String?
+    end
+  end
+end

data/sig/hakumi/steps/component.rbs

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Steps
+    class Component < Hakumi::BaseComponent
+      type steps_direction = :horizontal | :vertical
+      type steps_type = :default | :navigation | :inline
+      type steps_size = :default | :small
+      type steps_status = :wait | :process | :finish | :error
+      type steps_label_placement = :horizontal | :vertical
+      type steps_variant = :filled | :outlined
+
+      DIRECTIONS: Array[steps_direction]
+      TYPES: Array[steps_type]
+      SIZES: Array[steps_size]
+      STATUSES: Array[steps_status]
+      LABEL_PLACEMENTS: Array[steps_label_placement]
+      VARIANTS: Array[steps_variant]
+
+      @current: Integer
+      @direction: steps_direction
+      @type: steps_type
+      @size: steps_size
+      @status: steps_status
+      @label_placement: steps_label_placement?
+      @percent: Integer?
+      @progress_dot: bool
+      @responsive: bool
+      @initial: Integer
+      @clickable: bool
+      @variant: steps_variant
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?current: Integer,
+        ?direction: steps_direction,
+        ?type: steps_type,
+        ?size: steps_size,
+        ?status: steps_status,
+        ?label_placement: steps_label_placement?,
+        ?percent: Integer?,
+        ?progress_dot: bool,
+        ?responsive: bool,
+        ?initial: Integer,
+        ?clickable: bool,
+        ?variant: steps_variant,
+        **hakumi_html_options html_options
+      ) -> void
+
+      attr_reader current: Integer
+      attr_reader direction: steps_direction
+      attr_reader type: steps_type
+      attr_reader size: steps_size
+      attr_reader status: steps_status
+      attr_reader label_placement: steps_label_placement?
+      attr_reader percent: Integer?
+      attr_reader progress_dot: bool
+      attr_reader responsive: bool
+      attr_reader initial: Integer
+      attr_reader clickable: bool
+      attr_reader variant: steps_variant
+
+      def steps_classes: () -> String
+
+      def effective_label_placement: () -> steps_label_placement
+
+      def wrapper_attributes: () -> hakumi_html_options
+
+      def stimulus_controller: () -> String
+
+      def stimulus_data: () -> Hash[(Symbol | String), untyped]
+
+      def item_status: (Integer index) -> steps_status
+
+      def item_clickable?: (Integer index) -> bool
+
+      private
+
+      def validate_props!: () -> void
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Steps
+    module Item
+      class Component < Hakumi::BaseComponent
+        @title: String?
+        @description: String?
+        @status: Symbol?
+        @icon: hakumi_icon?
+        @disabled: bool
+        @html_options: hakumi_html_options
+
+        def initialize: (
+          ?title: String?,
+          ?description: String?,
+          ?status: Symbol?,
+          ?icon: hakumi_icon?,
+          ?disabled: bool,
+          **hakumi_html_options html_options
+        ) -> void
+
+        def call: () -> String
+
+        def step_classes: () -> String
+      end
+    end
+  end
+end

data/sig/hakumi/switch/component.rbs

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Switch
+    class Component < Hakumi::BaseComponent
+      include Hakumi::Concerns::FormField
+
+      SIZES: Array[hakumi_size_standard]
+
+      @name: String
+      @label: String?
+      @caption: String?
+      @checked: bool
+      @disabled: bool
+      @loading: bool
+      @size: hakumi_size_standard
+      @checked_text: String?
+      @unchecked_text: String?
+      @standalone: bool
+      @required: bool
+      @errors: Array[String]
+      @wrapper_class: String?
+      @html_options: hakumi_html_options
+
+      def initialize: (
+        ?name: String?,
+        ?label: String?,
+        ?caption: String?,
+        ?checked: bool?,
+        ?default_checked: bool,
+        ?disabled: bool,
+        ?loading: bool,
+        ?size: hakumi_size_standard,
+        ?checked_text: String?,
+        ?unchecked_text: String?,
+        ?standalone: bool,
+        ?required: bool,
+        ?errors: (Array[String] | String),
+        **hakumi_html_options html_options
+      ) -> void
+
+      private
+
+      def validate_props!: () -> void
+      def wrapper_classes: () -> String
+      def wrapper_attributes: () -> hakumi_html_options
+      def input_attributes: () -> hakumi_html_options
+      def checked_content: () -> String?
+      def unchecked_content: () -> String?
+    end
+  end
+end

data/sig/hakumi/table/column/component.rbs

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Table
+    module Column
+      class Component < Hakumi::BaseComponent
+        @title: String
+        @data_index: (String | Symbol)?
+        @key: (String | Symbol)?
+        @align: (:left | :center | :right)?
+        @width: (String | Integer)?
+        @ellipsis: (bool | Hash[Symbol, untyped])
+        @sorter: untyped  # Proc or bool
+        @sort_directions: (Array[Symbol] | nil)
+        @sort_order: (Symbol | nil)
+        @default_sort_order: (Symbol | nil)
+        @filters: (Array[Hash[Symbol, untyped]] | nil)
+        @filter_multiple: bool
+        @filtered_value: (Array[untyped] | nil)
+        @default_filtered_value: (Array[untyped] | nil)
+        @filter_mode: (Symbol | nil)
+        @filter_search: (bool | nil)
+        @hidden: bool
+        @on_cell: untyped  # Proc or nil
+        @class_name: (String | nil)
+        @options: Hash[Symbol, untyped]
+        @block: (Proc | nil)
+
+        def initialize: (
+          title: String,
+          ?data_index: (String | Symbol)?,
+          ?key: (String | Symbol)?,
+          ?align: (:left | :center | :right)?,
+          ?width: (String | Integer)?,
+          ?ellipsis: (bool | Hash[Symbol, untyped]),
+          ?sorter: untyped,
+          ?sort_directions: (Array[Symbol] | nil),
+          ?sort_order: (Symbol | nil),
+          ?default_sort_order: (Symbol | nil),
+          ?filters: (Array[Hash[Symbol, untyped]] | nil),
+          ?filter_multiple: bool,
+          ?filtered_value: (Array[untyped] | nil),
+          ?default_filtered_value: (Array[untyped] | nil),
+          ?filter_mode: (Symbol | nil),
+          ?filter_search: (bool | nil),
+          ?hidden: bool,
+          ?on_cell: untyped,
+          ?class_name: (String | nil),
+          **untyped options
+        ) { () -> untyped } -> void
+
+        # Converts column component to hash for Table component consumption
+        def to_h: () -> Hash[Symbol, untyped]
+      end
+    end
+  end
+end

data/sig/hakumi/table/column_group/component.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Hakumi
+  module Table
+    module ColumnGroup
+      class Component < Hakumi::BaseComponent
+        @title: String?
+        # @children is not actually used - ViewComponent slots manage columns
+        @html_options: hakumi_html_options
+
+        def initialize: (?title: String?, **hakumi_html_options html_options) -> void
+
+        def call: () -> String
+
+        # Returns column group config hash with title, key, align, width, hidden, children
+        def to_h: () -> Hash[Symbol, untyped]
+      end
+    end
+  end
+end