Class: Funicular::FormBuilder

Inherits:
Object
  • Object
show all
Defined in:
sig/form_builder.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FormBuilder

Returns a new instance of FormBuilder.

Parameters:

  • component (Component)
  • view_context (ViewContext)
  • model_key (Symbol)
  • options (Hash[Symbol, untyped]) 


8
 
# File 'sig/form_builder.rbs', line 8

def initialize: (Component component, ViewContext view_context, Symbol model_key, ?Hash[Symbol, untyped] options) -> void

Instance Attribute Details

#component ⇒ Component (readonly)

Returns the value of attribute component.

Returns:



3
4
5
 
# File 'sig/form_builder.rbs', line 3

def component
  @component
end

#model_key ⇒ Symbol (readonly)

Returns the value of attribute model_key.

Returns:

  • (Symbol) 


5
6
7
 
# File 'sig/form_builder.rbs', line 5

def model_key
  @model_key
end

#options ⇒ Hash[Symbol, untyped] (readonly)

Returns the value of attribute options.

Returns:

  • (Hash[Symbol, untyped]) 


6
7
8
 
# File 'sig/form_builder.rbs', line 6

def options
  @options
end

#view_context ⇒ ViewContext (readonly)

Returns the value of attribute view_context.

Returns:



4
5
6
 
# File 'sig/form_builder.rbs', line 4

def view_context
  @view_context
end

Instance Method Details

#checkbox ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



16
 
# File 'sig/form_builder.rbs', line 16

def checkbox: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#email_field ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



13
 
# File 'sig/form_builder.rbs', line 13

def email_field: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#file_field ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



18
 
# File 'sig/form_builder.rbs', line 18

def file_field: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#label ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • text (String, nil)
  • options (Hash[Symbol, untyped])

Returns:



20
 
# File 'sig/form_builder.rbs', line 20

def label: (Symbol field_name, ?String? text, ?Hash[Symbol, untyped] options) -> VDOM::Element

#number_field ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



14
 
# File 'sig/form_builder.rbs', line 14

def number_field: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#password_field ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



12
 
# File 'sig/form_builder.rbs', line 12

def password_field: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#select ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • choices (Array[untyped])
  • options (Hash[Symbol, untyped])

Returns:



17
 
# File 'sig/form_builder.rbs', line 17

def select: (Symbol field_name, Array[untyped] choices, ?Hash[Symbol, untyped] options) -> VDOM::Element

#submit ⇒ VDOM::Element

Parameters:

  • label (String)
  • options (Hash[Symbol, untyped])

Returns:



19
 
# File 'sig/form_builder.rbs', line 19

def submit: (?String label, ?Hash[Symbol, untyped] options) -> VDOM::Element

#text_field ⇒ VDOM::Element

Field builder methods

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



11
 
# File 'sig/form_builder.rbs', line 11

def text_field: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element

#textarea ⇒ VDOM::Element

Parameters:

  • field_name (Symbol)
  • options (Hash[Symbol, untyped])

Returns:



15
 
# File 'sig/form_builder.rbs', line 15

def textarea: (Symbol field_name, ?Hash[Symbol, untyped] options) -> VDOM::Element