Module: InertiaHanami::Props

Defined in:

lib/inertia_hanami/props.rb

Overview

Prop wrapper classes controlling how individual props are resolved and included in the Inertia response (partial reloads, deferred loading, etc).

Defined Under Namespace

Classes: Base

Constant Summary

Optional =

A prop that is only included in the response when explicitly requested by the client (via a partial reload).

Base.define(:block)

Always =

A prop that is always included in the response, even during a partial reload that would otherwise exclude it.

Base.define(:block)

Defer =

A prop that is loaded in a subsequent request after the initial page load, batched together by group.

Base.define(:group, :block) do
  def initialize(block:, group: "default")
    super
  end
end

Once =

A prop that is evaluated only once and cached by the client.

Base.define(:key, :fresh, :expires_in, :block) do
  def initialize(block:, key: nil, fresh: false, expires_in: nil)
    super
  end

  # Calculates the expiration timestamp in milliseconds.
  #
  # @return [Integer, nil] the expiration time as a Unix timestamp in milliseconds, or nil if no expiration
  def expires_at
    return unless expires_in

    ((Time.now + expires_in).to_f * 1_000).to_i
  end
end

Merge =

A prop whose value is merged with the existing client-side prop of the same name, instead of replacing it outright.

Base.define(:block, :deep_merge, :match_on) do
  def initialize(block:, deep_merge: false, match_on: nil)
    super
  end
end

Scroll =

A prop driving the client's infinite-scroll feature: merged (appended or prepended, per the X-Inertia-Infinite-Scroll-Merge-Intent header) instead of replacing the existing client-side prop, with pagination metadata surfaced via the response's scrollProps map.

Base.define(:block, :match_on, :page_name, :previous_page, :next_page, :current_page) do
  # rubocop:disable Metrics/ParameterLists -- one kwarg per client-visible scrollProps field
  def initialize(block:, match_on: nil, page_name: "page", previous_page: nil, next_page: nil, current_page: nil)
    super
  end
  # rubocop:enable Metrics/ParameterLists
end