Class: Plushie::Widget::Stack

Inherits:
Object
  • Object
show all
Defined in:
lib/plushie/widget/stack.rb

Overview

Stack layout -- layers children on top of each other.

Props:

  • width (length) -- stack width.
  • height (length) -- stack height.
  • clip (boolean) -- clip overflowing children.
  • a11y (hash) -- accessibility overrides.

Examples:

s = Plushie::Widget::Stack.new("layers", width: :fill, clip: true)
  .push(Plushie::Widget::Text.new("bg", "Background"))
  .push(Plushie::Widget::Text.new("fg", "Foreground"))
node = s.build

Constant Summary collapse

PROPS =

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

Supported property keys for this widget.

%i[width height clip a11y].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, **opts) ⇒ Stack

Returns a new instance of Stack.

Parameters:

  • id (String) —

    widget identifier

  • opts (Hash) —

    optional properties



29
30
31
32
33
 
# File 'lib/plushie/widget/stack.rb', line 29

def initialize(id, **opts)
  @id = id.to_s
  @children = opts.delete(:children) || []
  PROPS.each { |k| instance_variable_set(:"@#{k}", opts[k]) if opts.key?(k) }
end

Instance Attribute Details

#a11y ⇒ Object (readonly)

Returns the value of attribute a11y.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def a11y
  @a11y
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def children
  @children
end

#clip ⇒ Object (readonly)

Returns the value of attribute clip.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def clip
  @clip
end

#height ⇒ Object (readonly)

Returns the value of attribute height.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def height
  @height
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def id
  @id
end

#width ⇒ Object (readonly)

Returns the value of attribute width.



1
2
3
 
# File 'lib/plushie/widget/stack.rb', line 1

def width
  @width
end

Instance Method Details

#build ⇒ Plushie::Node

Returns:



49
50
51
52
53
54
55
56
57
 
# File 'lib/plushie/widget/stack.rb', line 49

def build
  props = {}
  PROPS.each do |key|
    val = instance_variable_get(:"@#{key}")
    Build.put_if(props, key, val)
  end
  Node.new(id: @id, type: "stack", props: props,
    children: Build.children_to_nodes(@children))
end

#push(child) ⇒ Stack

Append a child widget.

Parameters:

Returns:

  • (Stack) —

    new instance with the child appended



44
45
46
 
# File 'lib/plushie/widget/stack.rb', line 44

def push(child)
  dup.tap { _1.instance_variable_set(:@children, @children + [child]) }
end