avo 4.0.20 → 4.0.21

data/app/assets/stylesheets/css/layout.css

@@ -61,7 +61,7 @@
      app/views/avo/partials/_sidebar_width_override.html.erb (server-validated
      from the avo.sidebar.width cookie). With no cookie it is undefined and the
      fallback chain takes over: --sidebar-width-default, written by the same
-     carrier when the host sets Avo.configuration.sidebar_default_width, then
+     carrier when the host sets Avo.configuration.sidebar[:default_width], then
      --spacing(64) for the untouched 256px. That chain is deliberately INSIDE
      this media block — below lg the sidebar is a full-height overlay, so a wide
      configured default would cover a phone screen and the base declaration's

data/app/helpers/avo/application_helper.rb

@@ -292,7 +292,7 @@ module Avo
     def sidebar_width_max = SIDEBAR_WIDTH_MAX
 
     # Already clamped into the bounds by Avo::Configuration.
-    def sidebar_width_default = Avo.configuration.sidebar_default_width
+    def sidebar_width_default = Avo.configuration.sidebar[:default_width]
 
     # nil when the host has not changed the starting width, so the pre-paint
     # carrier emits nothing at all and the stylesheet's own --spacing(64)

data/app/javascript/js/controllers/sidebar_resize_controller.js

@@ -226,7 +226,7 @@ export default class extends Controller {
   }
 
   // The width the sidebar starts at with no stored preference — Avo's 256px
-  // unless the host set Avo.configuration.sidebar_default_width. This is what
+  // unless the host set Avo.configuration.sidebar[:default_width]. This is what
   // remove-when-default compares against, so reading it from config rather than
   // hardcoding 256 is what keeps a configured host from accumulating a cookie
   // that merely restates their own default.

data/app/views/avo/partials/_navbar.html.erb

@@ -6,8 +6,8 @@
 <%= content_tag :nav, class: class_names("top-navbar", {"print:hidden": Avo.configuration.hide_layout_when_printing}) do %>
   <div class="top-navbar__start">
     <%# Mobile always needs a toggle to reach the overlay sidebar. Desktop toggle
-        is optional and controlled by sidebar_toggle_visible. %>
-    <%= a_button class: class_names("shrink-0 -ms-1.5 lg:ms-0", "lg:hidden": !Avo.configuration.sidebar_toggle_visible),
+        is optional and controlled by sidebar[:toggle_visible]. %>
+    <%= a_button class: class_names("shrink-0 -ms-1.5 lg:ms-0", "lg:hidden": !Avo.configuration.sidebar[:toggle_visible]),
                  size: :sm,
                  style: :text,
                  padding: :sm,

data/app/views/avo/partials/_sidebar_resize_handle.html.erb

@@ -1,6 +1,6 @@
 <%# Resize handle for the desktop sidebar (R1–R3, R8, R18, R20–R22).
 
-  Rendered only when Avo.configuration.sidebar_resizable is on (the S5
+  Rendered only when Avo.configuration.sidebar[:resizable] is on (the S5
   accessibility off-switch), and always with `hidden` present (R20). The
   sidebar_resize controller is the SINGLE owner of that attribute: it removes
   `hidden` on connect when the sidebar is open at >= lg, and re-adds it
@@ -18,7 +18,7 @@
   (Unit 8 makes valuenow track the drag). They are required, not optional:
   axe-core 4.12 lists aria-valuenow as a mandatory attribute of role="separator".
   With no stored width the value is the starting width — Avo's 256px unless the
-  host set Avo.configuration.sidebar_default_width. %>
+  host set Avo.configuration.sidebar[:default_width]. %>
 <% current_width = @sidebar_width || sidebar_width_default %>
 <%= tag.div "",
   class: class_names("sidebar-resize-handle", "print:hidden": Avo.configuration.hide_layout_when_printing),

data/app/views/avo/partials/_sidebar_width_override.html.erb

@@ -3,7 +3,7 @@
   <script nonce="<%= content_security_policy_nonce %>">
     // Apply the sidebar width before first paint to avoid a 256px flash (R15).
     // Both values below are produced server-side as Integers within bounds
-    // (Avo::ApplicationHelper#sidebar_width, Avo::Configuration#sidebar_default_width),
+    // (Avo::ApplicationHelper#sidebar_width, Avo::Configuration#sidebar),
     // so they are interpolated as bare JS number literals — never a string taken
     // from the cookie or from the host's initializer.
     //

data/app/views/layouts/avo/application.html.erb

@@ -67,7 +67,7 @@
       <%# Immediately after the sidebar wrapper: after every nav link and both %>
       <%# skip links in the tab order, before the content. Must stay inside %>
       <%# .main to inherit --sidebar-offset-size, which positions it. %>
-      <%= render partial: "avo/partials/sidebar_resize_handle" if Avo.configuration.sidebar_resizable %>
+      <%= render partial: "avo/partials/sidebar_resize_handle" if Avo.configuration.sidebar[:resizable] %>
 
       <div class="flex lg:hidden">
         <%= render Avo::SidebarComponent.new sidebar_open: @sidebar_open, for_mobile: true %>

data/lib/avo/configuration.rb

@@ -65,17 +65,7 @@ module Avo
     attr_accessor :use_stacked_fields
     attr_accessor :default_editor_url
     attr_writer :body_classes
-    attr_accessor :sidebar_toggle_visible
-    # Off-switch for the drag-to-resize sidebar handle. Drag-only resizing is a
-    # known WCAG SC 2.5.7 (Dragging Movements) gap, so a host with an AA/VPAT
-    # obligation can disable it entirely; when false the handle is neither
-    # rendered nor wired up.
-    attr_accessor :sidebar_resizable
-    # Width the desktop sidebar starts at, in pixels, before the user drags it.
-    # Only applies at >= lg: below that the sidebar is a full-height overlay, and
-    # a wide configured value would cover a phone screen, so the mobile default
-    # stays 256px regardless.
-    attr_writer :sidebar_default_width
+    attr_writer :sidebar
     attr_accessor :tailwindcss_integration_enabled
     attr_accessor :mount_lookbook
 
@@ -215,9 +205,7 @@ module Avo
       @send_metadata = true
       @use_stacked_fields = false
       @default_editor_url = "cursor://file/%{path}"
-      @sidebar_toggle_visible = true
-      @sidebar_resizable = true
-      @sidebar_default_width = SIDEBAR_WIDTH_DEFAULT
+      @sidebar = {}
       @body_classes = []
       @tailwindcss_integration_enabled = true
       @mount_lookbook = false
@@ -247,6 +235,29 @@ module Avo
       }.freeze
     end
 
+    # Sidebar.
+    #
+    # `toggle_visible` shows the navbar button that collapses the desktop
+    # sidebar. On mobile the toggle is always visible regardless.
+    #
+    # `resizable` is the off-switch for the drag-to-resize handle. Drag-only
+    # resizing is a known WCAG SC 2.5.7 (Dragging Movements) gap, so a host with
+    # an AA/VPAT obligation can disable it entirely; when false the handle is
+    # neither rendered nor wired up.
+    #
+    # `default_width` is where the desktop sidebar starts, in pixels, before the
+    # user drags it. Only applies at >= lg: below that the sidebar is a
+    # full-height overlay, and a wide configured value would cover a phone
+    # screen, so the mobile default stays 256px regardless. It is absent here and
+    # filled in by the #sidebar reader: SIDEBAR_WIDTH_DEFAULT (lib/avo.rb) isn't
+    # defined yet when this constant is evaluated at require time.
+    unless defined?(SIDEBAR_DEFAULTS)
+      SIDEBAR_DEFAULTS = {
+        toggle_visible: true,
+        resizable: true
+      }.freeze
+    end
+
     # Global defaults for associations.
     #
     # `lookup_list_limit` caps how many records are listed in a belongs_to/attach
@@ -447,16 +458,28 @@ module Avo
       Avo::ExecutionContext.new(target: @body_classes).handle
     end
 
-    # Clamped into the same [SIDEBAR_WIDTH_MIN, SIDEBAR_WIDTH_MAX] range the drag
-    # and the persisted cookie use — outside it the sidebar would start at a
-    # width the handle cannot drag back to, and aria-valuenow would sit outside
-    # its own declared min/max. Anything unparseable falls back to the built-in
-    # default rather than clamping to the minimum, so a typo does not silently
-    # ship a 200px sidebar. The bounds constants stay private (lib/avo.rb):
-    # this accessor is the only host-facing width knob.
-    def sidebar_default_width
-      Integer(@sidebar_default_width, exception: false)
-        &.clamp(SIDEBAR_WIDTH_MIN, SIDEBAR_WIDTH_MAX) || SIDEBAR_WIDTH_DEFAULT
+    # `default_width` is clamped into the same [SIDEBAR_WIDTH_MIN,
+    # SIDEBAR_WIDTH_MAX] range the drag and the persisted cookie use — outside it
+    # the sidebar would start at a width the handle cannot drag back to, and
+    # aria-valuenow would sit outside its own declared min/max. Anything
+    # unparseable falls back to the built-in default rather than clamping to the
+    # minimum, so a typo does not silently ship a 200px sidebar. The bounds
+    # constants stay private (lib/avo.rb): this hash is the only host-facing knob.
+    def sidebar
+      config = SIDEBAR_DEFAULTS.merge(@sidebar)
+      width = Integer(config[:default_width], exception: false)&.clamp(SIDEBAR_WIDTH_MIN, SIDEBAR_WIDTH_MAX)
+
+      config.merge(default_width: width || SIDEBAR_WIDTH_DEFAULT)
+    end
+
+    # Backward-compatible flat accessor — the canonical home is now
+    # `config.sidebar[:toggle_visible]`.
+    def sidebar_toggle_visible
+      sidebar[:toggle_visible]
+    end
+
+    def sidebar_toggle_visible=(value)
+      @sidebar[:toggle_visible] = value
     end
 
     def persistence

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "4.0.20" unless const_defined?(:VERSION)
+  VERSION = "4.0.21" unless const_defined?(:VERSION)
 end

data/lib/avo.rb

@@ -37,7 +37,7 @@ module Avo
   # css/layout.css keeps a commented duplicate of the bounds.
   #
   # All three are private_constant. The BOUNDS have no host-facing knob by
-  # design. The DEFAULT does — `Avo.configuration.sidebar_default_width` — and
+  # design. The DEFAULT does — `Avo.configuration.sidebar[:default_width]` — and
   # this constant is only its fallback, so it must not become public API by
   # accident either. Reachable inside Avo via unqualified lexical lookup (e.g.
   # from Avo::Configuration and Avo::ApplicationHelper, both nested in Avo);

data/lib/generators/avo/templates/initializer/avo.tt

@@ -104,14 +104,21 @@ Avo.configure do |config|
   # }
 
   ## == Sidebar ==
-  # Width the sidebar starts at on desktop, in pixels, before a user drags it.
-  # Clamped to 200..480. Only applies at >= lg — below that the sidebar is a
-  # full-height overlay and stays 256px so it cannot cover a phone screen.
-  # config.sidebar_default_width = 256
+  # config.sidebar = {
+  #   # Show the navbar button that collapses the sidebar on desktop. On mobile
+  #   # the toggle is always visible regardless of this setting.
+  #   toggle_visible: true,
   #
-  # Set to false to remove the drag-to-resize handle entirely. Drag-only resizing
-  # is a known WCAG SC 2.5.7 gap, so hosts with an AA/VPAT obligation can opt out.
-  # config.sidebar_resizable = true
+  #   # Set to false to remove the drag-to-resize handle entirely. Drag-only
+  #   # resizing is a known WCAG SC 2.5.7 gap, so hosts with an AA/VPAT
+  #   # obligation can opt out.
+  #   resizable: true,
+  #
+  #   # Width the sidebar starts at on desktop, in pixels, before a user drags it.
+  #   # Clamped to 200..480. Only applies at >= lg — below that the sidebar is a
+  #   # full-height overlay and stays 256px so it cannot cover a phone screen.
+  #   default_width: 256
+  # }
 
   ## == Back to top button ==
   # config.back_to_top = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avo
 version: !ruby/object:Gem::Version
-  version: 4.0.20
+  version: 4.0.21
 platform: ruby
 authors:
 - Adrian Marin