Module: Tuile::ComponentUtil Private

Defined in:
lib/tuile/component_util.rb,
sig/tuile.rbs

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Pure queries over the component tree, as module functions:

ComponentUtil.effectively_visible?(field)   # false under a hidden panel

Home for a question that belongs to no one component and to no one asker. Deliberately not Component methods, for the reason D_empty_ancestor declined a Component#paintable?: each reads as a component-level concept and is really the framework's question.

The gate for a new member is a pure query over the tree — no state, no mutation — with two or more call sites in lib/; one caller stays private to the class that asks. Without it this becomes the drawer internal things go in.

Tuile-internal: a member may change or vanish with no migration note, and one an app turns out to need graduates to a documented home instead.

Class Method Summary collapse

Class Method Details

.effectively_visible?(component) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether component is genuinely on screen: attached, with neither it nor any ancestor hidden. Tuile::Component#visible? is a component's own flag alone, so a field under a hidden panel is still visible? itself.

A walk needs no such predicate — it prunes at the hidden subtree's root (Tuile::Component#walk_shown_tree).

@param component

Parameters:

Returns:

  • (Boolean) 


35
36
37
38
39
40
41
 
# File 'lib/tuile/component_util.rb', line 35

def effectively_visible?(component)
  raise TypeError, "expected Component, got nil" if component.nil?

  cursor = component
  cursor = cursor.parent while cursor&.visible?
  cursor.nil? && component.attached?
end