Class: SolidWebUi::Ui::RefreshControlsComponent

Inherits:

ViewComponent::Base

• Object
• ViewComponent::Base
• SolidWebUi::Ui::RefreshControlsComponent

Defined in:

app/components/solid_web_ui/ui/refresh_controls_component.rb

Overview

Live auto-refresh controls for a dashboard page: a frequency , a countdown to the next refresh and a manual "refresh now" button. The actual polling is driven by the bundled vanilla JS (app/assets/javascripts/ solid_web_ui.js), which reads the data-* attributes emitted here and reloads the turbo-frame named by frame_id. Rendering is pure markup, so the panel works whether or not Turbo is on the page (JS falls back to fetch+replace).

Constant Summary

STORAGE_KEY =

"swui:refresh-interval"

Instance Method Summary

• #initialize(frame_id:, default_interval: nil, intervals: nil) ⇒ RefreshControlsComponent constructor

  A new instance of RefreshControlsComponent.

Constructor Details

#initialize(frame_id:, default_interval: nil, intervals: nil) ⇒ RefreshControlsComponent

Returns a new instance of RefreshControlsComponent.

# File 'app/components/solid_web_ui/ui/refresh_controls_component.rb', line 14

def initialize(frame_id:, default_interval: nil, intervals: nil)
  @frame_id = frame_id
  @default_interval = (default_interval || SolidWebUi.config.refresh_interval).to_i
  @intervals = Array(intervals || SolidWebUi.config.refresh_intervals).map(&:to_i)
end

Generated on Thu Oct 8 14:26:47 2026 by yard 0.9.45 (ruby-4.0.7).