Contents

# frozen_string_literal: true

class Shoes
  module Common
    module Visibility
      # Hides the element, so that it can't be seen. See also #show and #toggle.
      def hide
        style(hidden: true)
        self
      end

      # Root method for determining whether we're visible or not, taking into
      # account our parent chain's visibility.
      def hidden?
        (defined?(@parent) && @parent&.hidden?) || style[:hidden]
      end

      alias hidden hidden?

      def visible?
        !hidden?
      end

      def hidden_from_view?
        hidden? || outside_parent_view?
      end

      def outside_parent_view?
        # Painted elements handle slot bounds themselves when painting
        return false if @parent.nil? || @parent.variable_height? || painted?

        # We hide when we're at all outside our parent's bounds
        !@parent.contains?(dimensions)
      end

      # Reveals the element, if it is hidden. See also #hide and #toggle.
      def show
        style(hidden: false)
        self
      end

      # Hides an element if it is shown. Or shows the element, if it is hidden.
      # See also #hide and #show.
      def toggle
        style(hidden: !style[:hidden])
        self
      end

      private

      # Backend elements are expected to respond to update_visibility, and use
      # the hidden? or visible? accessors to assess their proper display state.
      #
      # These take into account parent visibility, versus styling which applies
      # only to the element itself.
      def update_visibility
        gui.update_visibility
        self
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
shoes-core-4.0.0.rc1	lib/shoes/common/visibility.rb