Class: Funicular::Component

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

Direct Known Subclasses

ErrorBoundary

Defined Under Namespace

Classes: ResourceAccessor, StateAccessor

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Component

Returns a new instance of Component.

Parameters:

  • props (Hash[Symbol, untyped]) 


31
 
# File 'sig/component.rbs', line 31

def initialize: (?Hash[Symbol, untyped] props) -> void

Instance Attribute Details

#children ⇒ Array[VDOM::child_t]

Returns the value of attribute children.

Returns:

  • (Array[VDOM::child_t]) 


25
26
27
 
# File 'sig/component.rbs', line 25

def children
  @children
end

#current_children ⇒ Array[VDOM::child_t]?

Returns the value of attribute current_children.

Returns:

  • (Array[VDOM::child_t], nil) 


26
27
28
 
# File 'sig/component.rbs', line 26

def current_children
  @current_children
end

#dom_element ⇒ JS::Element

Returns the value of attribute dom_element.

Returns:

  • (JS::Element) 


22
23
24
 
# File 'sig/component.rbs', line 22

def dom_element
  @dom_element
end

#mounted ⇒ Boolean

Returns the value of attribute mounted.

Returns:

  • (Boolean) 


23
24
25
 
# File 'sig/component.rbs', line 23

def mounted
  @mounted
end

#props ⇒ Hash[Symbol, untyped]

Returns the value of attribute props.

Returns:

  • (Hash[Symbol, untyped]) 


20
21
22
 
# File 'sig/component.rbs', line 20

def props
  @props
end

#refs ⇒ Hash[Symbol, JS::Element] (readonly)

Returns the value of attribute refs.

Returns:

  • (Hash[Symbol, JS::Element]) 


27
28
29
 
# File 'sig/component.rbs', line 27

def refs
  @refs
end

#runtime ⇒ Runtime

Returns the value of attribute runtime.

Returns:



24
25
26
 
# File 'sig/component.rbs', line 24

def runtime
  @runtime
end

#vdom ⇒ VDOM::VNode, ...

Returns the value of attribute vdom.

Returns:



21
22
23
 
# File 'sig/component.rbs', line 21

def vdom
  @vdom
end

Class Method Details

.styles {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

Yield Returns:

  • (void) 


32
 
# File 'sig/component.rbs', line 32

def self.styles: () { (StyleBuilder) -> void } -> void

.styles_definitions ⇒ Hash[Symbol, Hash[Symbol, untyped]]

Returns:

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


33
 
# File 'sig/component.rbs', line 33

def self.styles_definitions: () -> Hash[Symbol, Hash[Symbol, untyped]]

.suspense_definitions ⇒ Hash[Symbol, suspense_definition]

Returns:

  • (Hash[Symbol, suspense_definition]) 


35
 
# File 'sig/component.rbs', line 35

def self.suspense_definitions: () -> Hash[Symbol, suspense_definition]

.use_suspense ⇒ void

This method returns an undefined value.

Parameters:

  • name (Symbol)
  • loader (Object)
  • on_resolve: (Object)
  • min_delay: (Integer) 


34
 
# File 'sig/component.rbs', line 34

def self.use_suspense: (Symbol name, untyped loader, ?on_resolve: untyped, ?min_delay: Integer) -> void

Instance Method Details

#add_child_from_view ⇒ void

This method returns an undefined value.

Parameters:

  • child (Object) 


61
 
# File 'sig/component.rbs', line 61

def add_child_from_view: (untyped child) -> void

#add_via ⇒ void

This method returns an undefined value.

Parameters:

  • element_id (String)
  • from (String)
  • to (String)
  • duration: (Integer) 


75
 
# File 'sig/component.rbs', line 75

def add_via: (String element_id, String from, String to, ?duration: Integer) ?{ () -> void } -> void

#bind_events ⇒ void

This method returns an undefined value.

Parameters:



58
 
# File 'sig/component.rbs', line 58

def bind_events: (JS::Element dom_element, VDOM::VNode | VDOM::Text | nil vnode) -> void

#build_button_to {|arg0| ... } ⇒ VDOM::Element

Parameters:

  • h (ViewContext)
  • path (String)
  • method: (Symbol)
  • options (Object)

Yields:

Yield Parameters:

Yield Returns:

  • (Object)

Returns:



64
 
# File 'sig/component.rbs', line 64

def build_button_to: (ViewContext h, String path, ?method: Symbol, **untyped options) { (ViewContext) -> untyped } -> VDOM::Element

#build_form_for {|arg0| ... } ⇒ VDOM::Element

Parameters:

  • h (ViewContext)
  • model_key (Symbol)
  • options (Hash[Symbol, untyped])

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:



62
 
# File 'sig/component.rbs', line 62

def build_form_for: (ViewContext h, Symbol model_key, ?Hash[Symbol, untyped] options) { (FormBuilder) -> void } -> VDOM::Element

#build_link_to {|arg0| ... } ⇒ VDOM::Element

Parameters:

Yields:

Yield Parameters:

Yield Returns:

  • (Object)

Returns:



63
 
# File 'sig/component.rbs', line 63

def build_link_to: (ViewContext h, String path, **untyped options) { (ViewContext) -> untyped } -> VDOM::Element

#build_vdom ⇒ VDOM::VNode, ...

Returns:



56
 
# File 'sig/component.rbs', line 56

def build_vdom: () -> (VDOM::VNode | VDOM::Text | nil)

#collect_refs ⇒ Hash[Symbol, JS::Element]

Parameters:

Returns:

  • (Hash[Symbol, JS::Element]) 


59
 
# File 'sig/component.rbs', line 59

def collect_refs: (JS::Element dom_element, VDOM::VNode | VDOM::Text | nil vnode, ?Hash[Symbol, JS::Element] refs_map) -> Hash[Symbol, JS::Element]

#component_mounted ⇒ void

This method returns an undefined value.



67
 
# File 'sig/component.rbs', line 67

def component_mounted: () -> void

#component_raised ⇒ void

This method returns an undefined value.

Parameters:

  • e (Exception) 


72
 
# File 'sig/component.rbs', line 72

def component_raised: (Exception e) -> void

#component_unmounted ⇒ void

This method returns an undefined value.



71
 
# File 'sig/component.rbs', line 71

def component_unmounted: () -> void

#component_updated ⇒ void

This method returns an undefined value.



69
 
# File 'sig/component.rbs', line 69

def component_updated: () -> void

#component_will_mount ⇒ void

This method returns an undefined value.



66
 
# File 'sig/component.rbs', line 66

def component_will_mount: () -> void

#component_will_unmount ⇒ void

This method returns an undefined value.



70
 
# File 'sig/component.rbs', line 70

def component_will_unmount: () -> void

#component_will_update ⇒ void

This method returns an undefined value.



68
 
# File 'sig/component.rbs', line 68

def component_will_update: () -> void

#hydrate ⇒ void

This method returns an undefined value.

Parameters:

  • dom_element (JS::Element) 


53
 
# File 'sig/component.rbs', line 53

def hydrate: (JS::Element dom_element) -> void

#initialize_state ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


40
 
# File 'sig/component.rbs', line 40

def initialize_state: () -> Hash[Symbol, untyped]

#load_single_suspense ⇒ void

This method returns an undefined value.

Parameters:

  • name (Symbol)
  • definition (suspense_definition, nil) 


44
 
# File 'sig/component.rbs', line 44

def load_single_suspense: (Symbol name, ?suspense_definition? definition) -> void

#load_suspense_data ⇒ void

This method returns an undefined value.



43
 
# File 'sig/component.rbs', line 43

def load_suspense_data: () -> void

#mount ⇒ void

This method returns an undefined value.

Parameters:

  • container (JS::Element) 


52
 
# File 'sig/component.rbs', line 52

def mount: (JS::Element container) -> void

#normalize_vnode_for_view ⇒ VDOM::Element, ...

Parameters:

  • value (Object)

Returns:



60
 
# File 'sig/component.rbs', line 60

def normalize_vnode_for_view: (untyped value) -> (VDOM::Element | VDOM::Text | VDOM::Component | nil)

#patch ⇒ void

This method returns an undefined value.

Parameters:

  • new_state (Hash[Symbol, untyped]) 


51
 
# File 'sig/component.rbs', line 51

def patch: (Hash[Symbol, untyped] new_state) -> void

#reload_suspense ⇒ void

This method returns an undefined value.

Parameters:

  • name (Symbol) 


45
 
# File 'sig/component.rbs', line 45

def reload_suspense: (Symbol name) -> void

#remove_via ⇒ void

This method returns an undefined value.

Parameters:

  • element_id (String)
  • from (String)
  • to (String)
  • duration: (Integer) 


74
 
# File 'sig/component.rbs', line 74

def remove_via: (String element_id, String from, String to, ?duration: Integer) ?{ () -> void } -> void

#render ⇒ VDOM::VNode, ...

Parameters:

Returns:

  • (VDOM::VNode, String, Integer, Float, Array[untyped], nil) 


55
 
# File 'sig/component.rbs', line 55

def render: (ViewContext h) -> (VDOM::VNode | String | Integer | Float | Array[untyped] | nil)

#render_suspense {|arg0, arg1| ... } ⇒ Object

Parameters:

  • h (ViewContext)
  • name (Symbol)
  • fallback: (Object)
  • error: (Object)

Yields:

Yield Parameters:

Yield Returns:

  • (Object)

Returns:

  • (Object) 


49
 
# File 'sig/component.rbs', line 49

def render_suspense: (ViewContext h, Symbol name, fallback: untyped, ?error: untyped) { (ViewContext, ResourceAccessor) -> untyped } -> untyped

#resources ⇒ ResourceAccessor

Returns:



38
 
# File 'sig/component.rbs', line 38

def resources: () -> ResourceAccessor

#seed_state ⇒ self

Parameters:

  • state_hash (Hash[untyped, untyped], nil)

Returns:

  • (self) 


41
 
# File 'sig/component.rbs', line 41

def seed_state: (Hash[untyped, untyped]? state_hash) -> self

#state ⇒ StateAccessor

Returns:



37
 
# File 'sig/component.rbs', line 37

def state: () -> StateAccessor

#styles ⇒ StyleAccessor

Returns:



39
 
# File 'sig/component.rbs', line 39

def styles: () -> StyleAccessor

#suspense_error ⇒ Object

Parameters:

  • name (Symbol)

Returns:

  • (Object) 


48
 
# File 'sig/component.rbs', line 48

def suspense_error: (Symbol name) -> untyped

#suspense_error? ⇒ Boolean

Parameters:

  • name (Symbol)

Returns:

  • (Boolean) 


47
 
# File 'sig/component.rbs', line 47

def suspense_error?: (Symbol name) -> bool

#suspense_loading? ⇒ Boolean

Parameters:

  • names (Symbol)

Returns:

  • (Boolean) 


46
 
# File 'sig/component.rbs', line 46

def suspense_loading?: (*Symbol names) -> bool

#unmount ⇒ void

This method returns an undefined value.



54
 
# File 'sig/component.rbs', line 54

def unmount: () -> void