keystone_ui 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2f3f4d0784444fc8cf7acde02c493fa2829dbcca367d1af4a852338b6f42212
-  data.tar.gz: 366951b7d1e19d053229c9c509db6555a8de379442e7bf0d11dfb9637992e012
+  metadata.gz: d7a0b5685fe1dc1107e8e75d274e80401826ed52616ae95c20d6a288fdc5c647
+  data.tar.gz: 8220957d8d617f0c32c71b264c84c5bf8b992a3cc2e3bb512f3f4e0a1cbf8bb0
 SHA512:
-  metadata.gz: 8f8064c88fc4ce2937ec84bff38ee5a60eab0fe03380995af9204fc2ccc58d82ec7c5cf89203ceb991088b0e0e06c6aa1b9d4106b251b099ea86e8303a686d85
-  data.tar.gz: d9453549349d298e249bab69ee78ea54d70a09c1cbf989c9aaba21c307c8525b985708f4645e3374bb99e72457954cf9c5d39c4a5f71ab7ecbe6c0e4f490f17b
+  metadata.gz: 58889e18335df436f8b13caad57648caf6ed3e13e17b50dc5d6011ae0f8fa85ceb98a9e9fd682f90cd10729ed3d3f20603ed34e438afb09a33090ec4d7493c95
+  data.tar.gz: c79c624b0a0a09e83b1f6fcee1566df17c7adf96f8141a20c8ee3ed20b361ab7faa1135be33bcf41f780e68e663e78d9ba833d27af09e72c782d4763a09463da

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

@@ -5,17 +5,19 @@ module Keystone
     class Column
       attr_reader :key, :header_text
 
-      def initialize(key, header_text, mobile_hidden: false, sortable: false, hideable: false)
+      def initialize(key, header_text, mobile_hidden: false, sortable: false, hideable: false, locked: false)
         @key = key
         @header_text = header_text
         @mobile_hidden = mobile_hidden
         @sortable = sortable
         @hideable = hideable
+        @locked = locked
       end
 
       def mobile_hidden? = @mobile_hidden
       def sortable? = @sortable
-      def hideable? = @hideable
+      def hideable? = @hideable && !@locked
+      def locked? = @locked
     end
   end
 end

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

@@ -17,6 +17,8 @@ module Keystone
       ROW_CLASSES_LAST = "ks-table-cell-last text-right text-sm whitespace-nowrap"
 
       MOBILE_HIDDEN_CLASSES = "hidden sm:table-cell"
+      HEADER_LOCKED_CLASSES = "ks-table-header-locked sticky left-0"
+      CELL_LOCKED_CLASSES = "ks-table-cell-locked sticky left-0"
 
       SORT_LINK_CLASSES = "ks-table-sort-link group inline-flex items-center"
       SORT_ICON_CLASSES = "h-4 w-4 flex-shrink-0"
@@ -76,6 +78,7 @@ module Keystone
         cells = @columns.map.with_index do |column, index|
           tokens = [ header_classes_for(index) ]
           tokens << MOBILE_HIDDEN_CLASSES if column.mobile_hidden?
+          tokens << HEADER_LOCKED_CLASSES if index.zero? && column.locked?
 
           cell = {
             label: column.header_text,
@@ -119,6 +122,7 @@ module Keystone
           @columns.map.with_index do |column, index|
             tokens = [ row_classes_for(index) ]
             tokens << MOBILE_HIDDEN_CLASSES if column.mobile_hidden?
+            tokens << CELL_LOCKED_CLASSES if index.zero? && column.locked?
 
             cell = {
               value: resolve_value(item, column.key),

data/lib/keystone_ui/version.rb

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

data/the_local/agents/keystone_ui-develop.md

@@ -245,11 +245,16 @@ outer element. See Conventions before using it.
   supplier returns nothing, when no supplier is set, or when no `key:` is
   passed, the table renders from `hidden_columns:` with no Columns menu. In
   every case `hidden_columns:` is the table's default layout.
-- `Keystone::Ui::Column.new(key, header_text, mobile_hidden: false, sortable: false, hideable: false)`
+- `Keystone::Ui::Column.new(key, header_text, mobile_hidden: false, sortable: false, hideable: false, locked: false)`
   — a column with per-column options, for when a `{ key: "Label" }` hash is not
   enough. `mobile_hidden:` hides the column below `sm:`; `sortable:` opts it into
   sort headers; `hideable:` lets the Columns menu hide it and move it, and a
-  saved `"column_order"` place it.
+  saved `"column_order"` place it. `locked: true` on the table's first column
+  keeps its header and cells in view while the rest of the table scrolls
+  sideways. A locked column that is not first renders as an ordinary column. A
+  locked column is never hideable, even with `hideable: true`: it is left out of
+  the Columns menu, `hidden_columns:` and a saved layout cannot hide it, and a
+  saved `"column_order"` cannot move it.
 - `ui_column_picker(columns:, hidden_columns: [], save_url: nil)` — a "Columns"
   dropdown with one row per `hideable` column, in the order `columns:` lists
   them. Each row has a checkbox and an up and a down button that move the
@@ -540,8 +545,16 @@ outer element. See Conventions before using it.
 
 6. For a table, decide how columns are declared. Use `{ key: "Label" }` hashes
    when every column is plain. Switch the whole set to `Keystone::Ui::Column`
-   objects as soon as one column needs `mobile_hidden:`, `sortable:`, or
-   `hideable:`.
+   objects as soon as one column needs `mobile_hidden:`, `sortable:`,
+   `hideable:`, or `locked:`.
+
+   To keep a wide table's first column, such as a name, in view while the rest
+   scrolls sideways, declare it first with `locked: true`. Whether a table locks
+   its first column is the developer's choice, so ask rather than pick. If the
+   locked column stays in place but the scrolled columns show through its
+   cells, the app's keystone_ui-styles version does not define the
+   `ks-table-header-locked` and `ks-table-cell-locked` classes, so stop and hand
+   that part to `keystone_ui-install`, and add no classes to fix it.
 
    For a table whose hideable columns a user should be able to choose and keep,
    check whether the app's Keystone UI initializer sets a

data/the_local/agents/keystone_ui-info.md

@@ -127,6 +127,13 @@ holds the catalog.
 - **The last table column is right-aligned.** In a data table with no actions
   column, the last column's header is right-aligned like the cells beneath it,
   so a figure or total placed in that header lines up with the figures below.
+- **A locked first column.** A table column can be marked locked. When it is
+  the table's first column, its header and cells stay in view while the rest
+  of the table scrolls sideways, styled by keystone_ui-styles' locked header
+  and cell classes. A locked column anywhere else renders as an ordinary
+  column. A locked column cannot be hidden or moved, so it never appears in the
+  "Columns" menu and a saved layout leaves it where it is, even when it is also
+  marked hideable.
 - **Saved table layouts.** A data table can be given a key naming it. A table
   with a key asks the app, or another gem such as keystone_ui-preferences, for
   the layout saved under that key for the request. A saved layout lists the

data/the_local/agents/keystone_ui-install.md

@@ -43,7 +43,7 @@ built on ViewComponent; hook it in before building any screen with those helpers
 ## How to use it
 
 1. Confirm the prerequisites: Ruby >= 3.2 and **tailwindcss-rails v4+** in the
-   host app. The gem brings ViewComponent and keystone_ui-styles 0.11.0 or later with it.
+   host app. The gem brings ViewComponent and keystone_ui-styles 0.12.0 or later with it.
    Tailwind does not have to be initialized first, because the generator creates
    the stylesheet if it is missing.
 
@@ -248,6 +248,9 @@ built on ViewComponent; hook it in before building any screen with those helpers
      `"hidden_columns"`, such as `{ "hidden_columns" => ["sku"] }`. That list
      replaces the hidden columns the table's own call passes, and an empty list
      shows every column. Only columns marked hideable are hidden.
+   - A column marked locked is never hideable, even when it is also marked
+     hideable. A saved layout cannot hide it or move it, and the Columns menu
+     does not list it.
    - When `value` is `nil`, or has no `"hidden_columns"` string key, the table
      keeps the hidden columns its own call passes. A symbol key is not read, so
      `{ hidden_columns: [...] }` also keeps them.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Tyler Schneider