Module: Vedeu::DSL::Border::InstanceMethods

Defined in:
lib/vedeu/dsl/border.rb

Overview

When Vedeu::DSL::Border is included in a class, the methods within this module are included as instance methods on that class.

Instance Method Summary collapse

Instance Method Details

#border(name = nil, &block) ⇒ Vedeu::Borders::Border

Specify the border of an interface or view with a simple DSL.

# As part of an interface:
Vedeu.interface :my_interface do
  border do
    # ... see {Vedeu::Borders::DSL}
  end
end

# As part of a view:
Vedeu.render do
  view :my_interface do
    border do
      # ... see {Vedeu::Borders::DSL}
    end
  end
end

Parameters:

  • name (String|Symbol) (defaults to: nil) —

    The name of the interface; this is already provided when we define the interface or view, setting it here is just mirroring functionality of ClassMethods.border.

  • block (Proc)

Returns:

Raises:

See Also:



77
78
79
80
81
82
83
84
 
# File 'lib/vedeu/dsl/border.rb', line 77

def border(name = nil, &block)
  fail Vedeu::Error::RequiresBlock unless block_given?

  model_name = name ? name : model.name

  Vedeu::Borders::Border.build(enabled: true,
                               name:    model_name, &block).store
end

#border! ⇒ Vedeu::Borders::Border

Applies the default border to the interface or view.

# As part of an interface:
Vedeu.interface :my_interface do
  border!

  # ... some code
end

# As part of a view:
Vedeu.render do
  view :my_interface do
    border!

    # ... some code
  end
end

Returns:



105
106
107
108
109
 
# File 'lib/vedeu/dsl/border.rb', line 105

def border!
  border do
    # adds default border
  end
end