odt-ui-rails 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3d502ed94d1a35d653519dbb0a8f3a8c357f0248e9d1d58c4830740b2f4332
-  data.tar.gz: bbec797d7209fc7f0728a41276092c6ccc907544d7e20d9cdcb91ff40530bf85
+  metadata.gz: 10337f9332af1c1db8c182d90d70779756c002616c77454ca8d1af89f81708b8
+  data.tar.gz: 8e33db7e338ca554cfe476f38d81483d1ba863d4b11e4869019eec3541542fae
 SHA512:
-  metadata.gz: 2fff4bd8c26cd16351373dca4bca8da03d0310d272c9c5cb2e0d731ecddc431e70fb863e9ff24ea9a6ea3a17e4a5adcdffdc445b9d46675ca92457ea08c758c0
-  data.tar.gz: d07f27f59a574e569ca69f6e49ed61e9dc85415941810be1b306af25734867f745233cb86d622c177631328213c38e946bc80e5890056a186853d1a844f72946
+  metadata.gz: aaebded1e337cfd81c708f2f74f59d796bd61ad3d8b54bc56a74afc125e2bd76f5130a897a32629546e58316bec53d334c578a48134bdd74499ee08aeaf04bfc
+  data.tar.gz: ad4d3582146da249c419376707d2d707f99653b6a6be279f4e07f880e7b758937efab206f07c7e5d6fa81eb225c65285f1daa287144bf3d044dfc94df2a0eb64

data/lib/odt_ui/helper.rb

@@ -164,7 +164,7 @@ module OdtUi
     # @param variant [:subtle, :filled, :outline]
     # @param color [:primary, :secondary, :success, :warning, :danger, :info, :neutral]
     # @param size [:sm, :md]
-    # @param radius [:none, :xs, :sm, :md, :lg, :xl, 2xl, 3xl, 4xl, :full]
+    # @param radius [:none, :xs, :sm, :md, :lg, :xl, :"2xl", :"3xl", :"4xl", :full]
     # @param dot [Boolean]
     # @param icon [String, nil]
     # @return [ActiveSupport::SafeBuffer]
@@ -195,8 +195,8 @@ module OdtUi
     # @param title [String, nil]
     # @param subtitle [String, nil]
     # @param variant [:elevated, :frosted, :subtle, :muted, :outlined]
-    # @param radius [:none, :xs, :sm, :md, :lg, :xl, 2xl, 3xl, 4xl, :full]
-    # @param border [Boolean, :subtle, :line]
+    # @param radius [:none, :xs, :sm, :md, :lg, :xl, :"2xl", :"3xl", :"4xl", :full]
+    # @param border [Boolean, Symbol, String]
     # @param hover [Boolean]
     # @return [ActiveSupport::SafeBuffer]
     def odt_card(title: nil, subtitle: nil, variant: :frosted, radius: :"3xl", border: false, hover: true, **html_options, &block)

data/lib/odt_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OdtUi
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/sig/odt_ui.rbs

@@ -0,0 +1,97 @@
+module OdtUi
+  VERSION: String
+
+  module Helper
+    type button_variant = :filled | :light | :outline | :subtle | :ghost | String
+    type button_color = :primary | :secondary | :success | :warning | :danger | :neutral | String
+    type button_size = :xs | :sm | :md | :lg | :xl | String
+    type radius_size = :none | :xs | :sm | :md | :lg | :xl | :"2xl" | :"3xl" | :"4xl" | :full | Symbol | String
+
+    type badge_variant = :subtle | :filled | :outline | String
+    type badge_color = :primary | :secondary | :success | :warning | :danger | :info | :neutral | String
+    type badge_size = :sm | :md | String
+
+    type card_variant = :elevated | :frosted | :subtle | :muted | :outlined | String
+    type alert_variant = :success | :warning | :danger | :info | String
+    type heading_tag = :h1 | :h2 | :h3 | :h4 | :h5 | String
+    type text_color = :default | :strong | :muted | :subtle | :primary | String
+    type text_size = :xs | :sm | :base | :lg | String
+    type avatar_size = :xs | :sm | :md | :lg | :xl | String
+    type avatar_color = :secondary | :primary | :neutral | String
+
+    # Renders an ODT Button component.
+    #
+    # @param text [String, nil] Button label text
+    # @param variant [:filled, :light, :outline, :subtle, :ghost] Button style variant (default: :filled)
+    # @param color [:primary, :secondary, :success, :warning, :danger, :neutral] Button theme color (default: :primary)
+    # @param size [:xs, :sm, :md, :lg, :xl] Size of the button (default: :md)
+    # @param radius [:none, :xs, :sm, :md, :lg, :xl, :"2xl", :"3xl", :"4xl", :full] Border radius (default: :full)
+    # @param href [String, nil] URL if rendering as an anchor link <a>
+    # @param icon [String, nil] Icon class (e.g. 'fa-solid fa-plus') or SVG string
+    # @param right_icon [String, nil] Right icon class or SVG string
+    # @param full_width [bool] Stretch button to 100% width (default: false)
+    # @param disabled [bool] Disabled state (default: false)
+    # @param type [String] Button type attribute (default: "button")
+    def odt_button: (?String? text, ?variant: button_variant, ?color: button_color, ?size: button_size, ?radius: radius_size, ?href: String?, ?icon: String?, ?right_icon: String?, ?full_width: bool, ?disabled: bool, ?type: String, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders an ODT Badge component.
+    #
+    # @param text [String, nil] Badge label text
+    # @param variant [:subtle, :filled, :outline] Badge style variant (default: :subtle)
+    # @param color [:primary, :secondary, :success, :warning, :danger, :info, :neutral] Badge color (default: :neutral)
+    # @param size [:sm, :md] Badge size (default: :sm)
+    # @param radius [:none, :xs, :sm, :md, :lg, :xl, :"2xl", :"3xl", :"4xl", :full] Border radius (default: :full)
+    # @param dot [bool] Whether to render a leading status dot (default: false)
+    # @param icon [String, nil] Icon class (e.g. 'fa-regular fa-calendar') or SVG string
+    def odt_badge: (?String? text, ?variant: badge_variant, ?color: badge_color, ?size: badge_size, ?radius: radius_size, ?dot: bool, ?icon: String?, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders an ODT Card component.
+    #
+    # @param title [String, nil] Card header title
+    # @param subtitle [String, nil] Card header subtitle
+    # @param variant [:elevated, :frosted, :subtle, :muted, :outlined] Surface style variant (default: :frosted)
+    # @param radius [:none, :xs, :sm, :md, :lg, :xl, :"2xl", :"3xl", :"4xl", :full] Corner radius (default: :"3xl")
+    # @param border [bool, Symbol, String] Border styling (default: false)
+    # @param hover [bool] Hover elevation effect (default: true)
+    def odt_card: (?title: String?, ?subtitle: String?, ?variant: card_variant, ?radius: radius_size, ?border: bool | Symbol | String, ?hover: bool, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders an ODT Alert banner.
+    #
+    # @param message [String, nil] Alert text message
+    # @param variant [:success, :warning, :danger, :info] Alert status variant (default: :success)
+    # @param icon [String, nil] Custom icon class or SVG
+    def odt_alert: (?String? message, ?variant: alert_variant, ?icon: String?, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders an ODT Heading element.
+    #
+    # @param text [String, nil] Heading text
+    # @param as [:h1, :h2, :h3, :h4, :h5] HTML heading tag (default: :h2)
+    def odt_heading: (?String? text, ?as: heading_tag, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders styled body text.
+    #
+    # @param text [String, nil] Body text content
+    # @param color [:default, :strong, :muted, :subtle, :primary] Text color variant (default: :default)
+    # @param size [:xs, :sm, :base, :lg] Text size (default: :base)
+    def odt_text: (?String? text, ?color: text_color, ?size: text_size, **untyped) ?{ () -> untyped } -> untyped
+
+    # Renders an ODT Avatar element with initials or image fallback.
+    #
+    # @param name [String, nil] User name for automatic initials generation
+    # @param src [String, nil] Image avatar URL
+    # @param size [:xs, :sm, :md, :lg, :xl] Avatar size (default: :sm)
+    # @param color [:secondary, :primary, :neutral] Background color theme (default: :secondary)
+    # @param icon [String] Fallback icon if no name or image provided (default: "fa-solid fa-user")
+    def odt_avatar: (?name: String?, ?src: String?, ?size: avatar_size, ?color: avatar_color, ?icon: String, **untyped) -> untyped
+  end
+end
+
+module ActionView
+  class Base
+    include OdtUi::Helper
+  end
+
+  module Helpers
+    include OdtUi::Helper
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odt-ui-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Pixel
@@ -45,6 +45,7 @@ files:
 - lib/odt_ui/engine.rb
 - lib/odt_ui/helper.rb
 - lib/odt_ui/version.rb
+- sig/odt_ui.rbs
 homepage: https://github.com/PixxelTK/ODT-Lightweight-UI
 licenses:
 - MIT