keystone_ui 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 903dfcff87cb63fce06692a39fb26b73af673f562f28f3b3ebf72b13b5280642
-  data.tar.gz: 7db5a26e387cc0c2b11a311c70e967ec977f5b1636c6d38bf8a42b28d5ffbd9a
+  metadata.gz: cdb61774853355f3b66ae9c1a7d6f4930005216827486777c19b582b3ac775f2
+  data.tar.gz: a815979ea629c273e43b8b7d39a20a1310908dedee967aec21b326e027784333
 SHA512:
-  metadata.gz: 574997b044dfcbb23b6aad3e74065b041d549d1be5a8629f5c08f792720f1fda5d988340516caa581f80c1455fcc3a32080174b8056f06a41c4fa58423236cbb
-  data.tar.gz: 30a7877baf982039cff72b9c8ad0dc879a8fdbc8362d8ec15cec9b7b48964aa8dc1786494b25e3c131e1c28a2c000054c33998011ea41b111da749e1863518f3
+  metadata.gz: '0975326ab4b00a0f6ce7f28ae8642e2bee4704e13509046a1c2ad820e50880ace96f0b0d0e66dfd95e29b3d7d56cff68f7e4aef1264c507b2480eb72d3b14c5d'
+  data.tar.gz: e06fedfeebf535bf2c17ae2dc30938878a05f3cfb918f29df694886538f2c88f97d83d5eb51e9210e4dcdc8bfdbf3b16c8daef006d0bc51f6f93815752c4268c

data/app/components/keystone/ui/form_field_component.html.erb

@@ -15,7 +15,7 @@
     <textarea name="<%= @attribute %>" rows="3" class="<%= Keystone::Ui::TextareaComponent::BASE_CLASSES %>"<% if @placeholder %> placeholder="<%= @placeholder %>"<% end %>><%= @value %></textarea>
   <% elsif select? %>
     <select name="<%= @attribute %>" class="<%= Keystone::Ui::SelectComponent::BASE_CLASSES %>">
-      <% unless required? %><option value=""></option><% end %>
+      <% unless required? %><option value=""><%= blank_option_text %></option><% end %>
       <% select_options.each do |label, value| %>
         <option value="<%= value %>" <%= "selected" if @value.to_s == value.to_s %>><%= label %></option>
       <% end %>

data/app/components/keystone/ui/form_field_component.rb

@@ -11,7 +11,7 @@ module Keystone
       CHECKBOX_CLASSES = "ks-checkbox"
       CHECKBOX_WRAPPER_CLASSES = "flex items-center gap-2"
 
-      def initialize(attribute:, label: nil, type: :text, required: false, hint: nil, placeholder: nil, min: nil, max: nil, step: nil, value: nil, options: [], errors: [])
+      def initialize(attribute:, label: nil, type: :text, required: false, hint: nil, placeholder: nil, min: nil, max: nil, step: nil, value: nil, options: [], errors: [], include_blank: nil)
         @attribute = attribute
         @label = label
         @type = type
@@ -24,6 +24,7 @@ module Keystone
         @value = value
         @options = options
         @errors = Array(errors)
+        @include_blank = include_blank.to_s
       end
 
       def label_text
@@ -66,6 +67,10 @@ module Keystone
         @options
       end
 
+      def blank_option_text
+        @include_blank
+      end
+
       def input_options
         options = { name: @attribute.to_s, class: Keystone::Ui::InputComponent::BASE_CLASSES }
         unless textarea?

data/lib/keystone_ui/theme_choice.rb

@@ -3,7 +3,7 @@
 module KeystoneUi
   class ThemeChoice
     COOKIE = "keystone_theme"
-    MODES = %w[light dark system].freeze
+    MODES = %w[light dark system custom].freeze
 
     def initialize(mode, supplied: nil)
       @mode = mode

data/lib/keystone_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KeystoneUi
-  VERSION = "0.13.0"
+  VERSION = "0.15.0"
 end

data/the_local/agents/keystone_ui-develop.md

@@ -96,7 +96,7 @@ outer element. See Conventions before using it.
   The `<form>` wrapper. `method:` may be `:patch`/`:put`/`:delete` and is
   translated for Rails. Set `multipart: true` when the form contains a file
   upload.
-- `ui_form_field(attribute:, label: nil, type: :text, required: false, hint: nil, placeholder: nil, min: nil, max: nil, step: nil, value: nil, options: [], errors: [])`
+- `ui_form_field(attribute:, label: nil, type: :text, required: false, hint: nil, placeholder: nil, min: nil, max: nil, step: nil, value: nil, options: [], errors: [], include_blank: nil)`
   — a labeled field with hint and error text. This is the default way to render
   an input. `type:` `:text` `:number` `:email` `:password` `:date` `:textarea`
   `:checkbox` `:select`. `attribute:` is used verbatim as the input's `name`, so
@@ -104,7 +104,9 @@ outer element. See Conventions before using it.
   pass `label:` whenever the attribute is a nested name. `label:` defaults to the
   attribute with underscores turned to spaces and the first letter capitalized.
   `options:` is for `:select` and takes `[[label, value], ...]`; `value:` picks
-  the selected option, and a non-required select gets a leading blank option. A
+  the selected option, and a non-required select gets a leading empty option,
+  worded by `include_blank:` (for example `"Not set yet"`) or left blank without
+  it. Never add your own empty choice to `options:` as well. A
   `:checkbox` renders its label beside the box, submits `"0"` when unchecked and
   `"1"` when checked, and pre-checks when `value:` is `"1"`. `errors:` is an
   array of message strings.

data/the_local/agents/keystone_ui-info.md

@@ -70,10 +70,12 @@ holds the catalog.
   Tailwind's stock `gray-*` and `zinc-*` neutrals, or fixed status colors such
   as green and amber, directly. Changing the defaults belongs to the install
   local.
-- **Light, dark and system themes.** Every component has dark-mode styling. The
-  theme is chosen in this order: the user's choice stored in a cookie, then a
-  mode another gem supplies, then light. System leaves the page to follow the
-  operating system.
+- **Light, dark, system and custom themes.** Every component has dark-mode
+  styling. The theme is chosen in this order: the user's choice stored in a
+  cookie, then a mode another gem supplies, then light. System leaves the page
+  to follow the operating system. Custom marks the page for a palette another
+  gem defines. The theme toggle does not offer it, so a page reaches it when
+  another gem supplies it.
 - **Tailwind classes are static strings.** Class names are never interpolated,
   so Tailwind's scanner can find them. Widths and heights that depend on data,
   such as a progress bar or a bucket's fill, are set with an inline style

data/the_local/agents/keystone_ui-install.md

@@ -20,7 +20,8 @@ built on ViewComponent; hook it in before building any screen with those helpers
   to the layout's `<html>` tag. Safe to re-run.
 - `KeystoneUi.configure` — a block yielding the configuration: `accent` and
   `surface` (palette names, `:blue` and `:zinc` unless set),
-  `theme_mode_supplier` (a callable that supplies a light, dark or system mode),
+  `theme_mode_supplier` (a callable that supplies a light, dark, system or
+  custom mode),
   and the `tailwind_imports` and `tailwind_sources` lists (extra CSS files and
   scan paths added to the Tailwind build).
 
@@ -61,7 +62,7 @@ built on ViewComponent; hook it in before building any screen with those helpers
      `registerControllers(application)`.
    - `app/views/layouts/application.html.erb` — adds
      `<%= keystone_theme_attributes %>` inside the `<html` tag, which writes the
-     light or dark mode onto the page.
+     light, dark or custom mode onto the page.
 
    Read its output for two warnings:
 
@@ -139,10 +140,14 @@ built on ViewComponent; hook it in before building any screen with those helpers
      reads the palette choice. Keystone UI stores the names and changes no color
      from them, because colors come from the CSS custom properties in step 6.
    - `theme_mode_supplier` — a callable that receives the view and returns
-     `"light"`, `"dark"` or `"system"`. It supplies the mode when the user has
-     not picked one with the theme toggle, since the `keystone_theme` cookie that
-     the toggle writes takes precedence. Any other return value, or no supplier,
-     falls back to light.
+     `"light"`, `"dark"`, `"system"`, `"custom"` or `nil`. It supplies the mode
+     when the user has not picked one with the theme toggle, since the
+     `keystone_theme` cookie that the toggle writes takes precedence. Any other
+     return value, or no supplier, falls back to light.
+   - A supplied `"custom"` marks the layout's `<html>` tag
+     `data-theme="custom"`. The theme toggle does not offer custom, so only a
+     supplier sets it. Ask the developer which gem or code supplies custom and
+     its colors before returning it.
    - `tailwind_imports` and `tailwind_sources` — lists to append to, never
      assign. Each import becomes an `@import` line and each source becomes an
      `@source` line in `keystone_source.css` on the next boot. They are for

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement