protos 0.2.0 → 0.2.2

data/lib/protos/swap.rb

@@ -2,9 +2,13 @@
 
 module Protos
   class Swap < Component
+    # DOCS: The swap component is a checkbox that can be toggled on and off to
+    # display different content.
+    # https://daisyui.com/components/swap/
+
     def template
       label(**attrs) do
-        input(type: :checkbox)
+        input(type: :checkbox, class: css[:input])
         yield if block_given?
       end
     end
@@ -21,7 +25,8 @@ module Protos
 
     def theme
       {
-        container: tokens("swap")
+        container: tokens("swap"),
+        input: tokens("hidden")
       }
     end
   end

data/lib/protos/table/body.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Body < Component
+      # DOCS: The body of a table
+
       def template(&block)
         tbody(**attrs, &block)
       end

data/lib/protos/table/caption.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Caption < Component
+      # DOCS: The caption of a table
+
       def template(&block)
         caption(**attrs, &block)
       end

data/lib/protos/table/cell.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Cell < Component
+      # DOCS: A single cell in a table
+
       option :align,
              type: Types::Coercible::Symbol.enum(:left, :center, :right),
              default: -> {

data/lib/protos/table/footer.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Footer < Component
+      # DOCS: The footer of a table
+
       def template(&block)
         tfoot(**attrs, &block)
       end

data/lib/protos/table/head.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Head < Component
+      # DOCS: The head of a table
+
       option :align,
              type: Types::Coercible::Symbol.enum(:left, :center, :right),
              default: -> {

data/lib/protos/table/header.rb

@@ -3,6 +3,9 @@
 module Protos
   class Table
     class Header < Component
+      # DOCS: The header of a table that contains many Protos::Table::Head
+      # components
+
       def template(&block)
         thead(**attrs, &block)
       end

data/lib/protos/table/row.rb

@@ -3,6 +3,8 @@
 module Protos
   class Table
     class Row < Component
+      # DOCS: The row of a table
+
       def template(&block)
         tr(**attrs, &block)
       end

data/lib/protos/table.rb

@@ -2,6 +2,22 @@
 
 module Protos
   class Table < Component
+    # DOCS: A table component
+    # https://daisyui.com/components/table/
+
+    option :pin_rows, default: -> { false }, type: Types::Bool
+    option :pin_columns, default: -> { false }, type: Types::Bool
+    option :striped, default: -> { false }, type: Types::Bool
+    option :size,
+           default: -> { :md },
+           reader: false,
+           type: Types::Coercible::Symbol.enum(
+             :xs,
+             :sm,
+             :md,
+             :lg
+           )
+
     def template(&block)
       div(**attrs) do
         table(class: css[:table], &block)
@@ -38,10 +54,25 @@ module Protos
 
     private
 
+    def size
+      {
+        xs: "table-xs",
+        sm: "table-sm",
+        md: "table-md",
+        lg: "table-lg"
+      }.fetch(@size)
+    end
+
     def theme
       {
         container: tokens("w-full", "overflow-x-auto"),
-        table: tokens("table")
+        table: tokens(
+          "table",
+          size,
+          pin_rows: "table-pin-rows",
+          pin_columns: "table-pin-columns",
+          striped: "table-striped"
+        )
       }
     end
   end

data/lib/protos/tabs/tab.rb

@@ -3,6 +3,8 @@
 module Protos
   class Tabs
     class Tab < Component
+      # DOCS: A single tab in a tabs component
+
       param :id
       option :label
       option :active, default: -> { false }

data/lib/protos/tabs.rb

@@ -2,6 +2,9 @@
 
 module Protos
   class Tabs < Component
+    # DOCS: A component that contains many Protos::Tab components
+    # https://daisyui.com/components/tab/
+
     option :type,
            default: -> { :default },
            reader: false,

data/lib/protos/theme.rb

@@ -2,6 +2,11 @@
 
 module Protos
   class Theme
+    # DOCS: A class that holds data for a theme. This class is used to safely
+    # merge in user supplied css classes into a default theme.
+    # This is the object that is returned by `css` and used to set slots for
+    # a component style.
+
     def initialize(theme = {}, **kwargs)
       @theme = theme.merge(kwargs)
     end

data/lib/protos/timeline/center.rb

@@ -3,6 +3,9 @@
 module Protos
   class Timeline
     class Center < Component
+      # DOCS: The center of a timeline. This would usually be an icon or
+      # something small that shows a point on the timeline.
+
       def template(&block)
         div(**attrs, &block)
       end

data/lib/protos/timeline/item.rb

@@ -3,6 +3,10 @@
 module Protos
   class Timeline
     class Item < Component
+      # DOCS: The item of a timeline. Usually containing a center, left and
+      # right and depending on its position in the list, an hr at the beginning
+      # or end.
+
       def template(&block)
         li(**attrs, &block)
       end

data/lib/protos/timeline/left.rb

@@ -3,6 +3,9 @@
 module Protos
   class Timeline
     class Left < Component
+      # DOCS: Content on the left (on daisyui "start") side of a timeline.
+      # We chose not to use start/end because of the keywork conflict with ruby.
+
       def template(&block)
         div(**attrs, &block)
       end

data/lib/protos/timeline/right.rb

@@ -3,6 +3,9 @@
 module Protos
   class Timeline
     class Right < Component
+      # DOCS: Content on the right (on daisyui "end") side of a timeline.
+      # We chose not to use start/end because of the keywork conflict with ruby.
+
       def template(&block)
         div(**attrs, &block)
       end

data/lib/protos/timeline.rb

@@ -2,6 +2,9 @@
 
 module Protos
   class Timeline < Component
+    # DOCS: A timeline component
+    # https://daisyui.com/components/timeline/
+
     option :vertical, type: Types::Bool, default: -> { false }
 
     def template(&block)

data/lib/protos/toast/close_button.rb

@@ -3,6 +3,8 @@
 module Protos
   class Toast
     class CloseButton < Component
+      # DOCS: A close button for a toast
+
       def template(&block)
         form(method: :dialog, class: css[:form]) do
           button(

data/lib/protos/toast.rb

@@ -2,16 +2,26 @@
 
 module Protos
   class Toast < Component
+    # DOCS: A toast component that can be used to display messages to the user
+    # that popup at a fixed position on the screen.
+    # https://daisyui.com/components/toast/
+
     Positions = Types::Symbol.enum(
-      :start,
-      :center,
-      :end,
-      :top,
-      :middle,
-      :bottom
+      :top_start,
+      :top_center,
+      :top_end,
+      :middle_start,
+      :middle_center,
+      :middle_end,
+      :bottom_start,
+      :bottom_center,
+      :bottom_end
     )
 
-    option :position, type: Positions, default: -> { :end }
+    option :position,
+           type: Positions,
+           default: -> { :bottom_end },
+           reader: false
 
     def template(&block)
       dialog(**attrs, &block)
@@ -29,11 +39,25 @@ module Protos
       }
     end
 
+    def position
+      {
+        top_start: "toast-start toast-top",
+        top_center: "toast-center toast-top",
+        top_end: "toast-end toast-top",
+        middle_start: "toast-start toast-middle",
+        middle_center: "toast-center toast-middle",
+        middle_end: "toast-end toast-middle",
+        bottom_start: "toast-start toast-bottom",
+        bottom_center: "toast-center toast-bottom",
+        bottom_end: "toast-end toast-bottom"
+      }.fetch(@position)
+    end
+
     def theme
       {
         container: tokens(
           "toast",
-          "toast-end",
+          position,
           "[&:not([open])]:hidden",
           "bg-transparent"
         )

data/lib/protos/token_list.rb

@@ -2,12 +2,18 @@
 
 module Protos
   class TokenList
+    # DOCS: A list of utility tokens that can handle parsing and merging sets of
+    # tokens together safely. It uses TailwindMerge to merge the tokens together
+    # while accounting for their conflicts.
+
     def self.parse(input)
       case input
       when String then new(input.split)
       when Array then new(input)
       when TokenList then input
-      else raise ArgumentError, "Invalid input: #{input.inspect}"
+      when NilClass then new
+      else raise ArgumentError,
+                 "Invalid input for #{self.class.name}: #{input.inspect}"
       end
     end
 

data/lib/protos/typography/heading.rb

@@ -3,6 +3,9 @@
 module Protos
   module Typography
     class Heading < Protos::Component
+      # DOCS: A heading component that encapsulates all heading levels by their
+      # size and level.
+
       SizeTypes = Types::Coercible::Symbol.enum(:xs, :sm, :md, :lg, :xl)
       LevelTypes = Types::Integer.enum(1, 2, 3, 4, 5, 6)
 

data/lib/protos/typography/inline_link.rb

@@ -3,6 +3,8 @@
 module Protos
   module Typography
     class InlineLink < Component
+      # DOCS: A link that is styled to be inline with text
+
       def template(&block)
         a(**attrs, &block)
       end

data/lib/protos/typography/paragraph.rb

@@ -3,6 +3,8 @@
 module Protos
   module Typography
     class Paragraph < Component
+      # DOCS: A paragraph of text
+
       def template(&block)
         p(**attrs, &block)
       end

data/lib/protos/typography.rb

@@ -2,6 +2,9 @@
 
 module Protos
   module Typography
+    # DOCS: The core typography module that can be mixedin to override the
+    # default elements with custom elements.
+
     def h1(**options, &block)
       render(Heading.new(level: 1, size: :xl, **options), &block)
     end

data/lib/protos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Protos
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Nolan J Tait
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core
@@ -93,6 +93,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/list.rb
 - examples/navbar.rb
 - lib/protos.rb
 - lib/protos/accordion.rb