Module: Funicular

Defined in:
lib/funicular.rb,
lib/funicular/ssr.rb,
lib/funicular/plugin.rb,
lib/funicular/schema.rb,
lib/funicular/railtie.rb,
lib/funicular/testing.rb,
lib/funicular/version.rb,
lib/funicular/compiler.rb,
lib/funicular/middleware.rb,
lib/funicular/ssr/runtime.rb,
lib/funicular/route_parser.rb,
lib/funicular/configuration.rb,
lib/funicular/commands/routes.rb,
lib/funicular/testing/node_runner.rb,
lib/funicular/helpers/picoruby_helper.rb,
lib/generators/funicular/chat/chat_generator.rb,
sig/http.rbs,
sig/vdom.rbs,
sig/cable.rbs,
sig/debug.rbs,
sig/model.rbs,
sig/store.rbs,
sig/differ.rbs,
sig/router.rbs,
sig/styles.rbs,
sig/patcher.rbs,
sig/runtime.rbs,
sig/component.rbs,
sig/funicular.rbs,
sig/file_upload.rbs,
sig/validations.rbs,
sig/form_builder.rbs,
sig/view_context.rbs,
sig/error_boundary.rbs,
sig/html_serializer.rbs,
sig/store_singleton.rbs,
sig/store_collection.rbs,
sig/environment_iquirer.rbs

Defined Under Namespace

Modules: Cable, Commands, Debug, EmptyRoutes, FileUpload, Generators, HTTP, Helpers, Plugin, SSR, Schema, Testing, VDOM Classes: Compiler, Component, Configuration, EnvironmentInquirer, Error, ErrorBoundary, FormBuilder, Middleware, Model, Railtie, RouteParser, Router, Runtime, Store, StyleAccessor, StyleBuilder, StyleValue, ViewContext

Constant Summary collapse

VENDOR_PICORUBY_DIR =

Path to the directory containing vendored PicoRuby.wasm builds.

File.expand_path("funicular/vendor/picoruby", __dir__)
VERSION =

Returns:

  • (String) 
"0.3.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



17
18
19
 
# File 'lib/funicular.rb', line 17

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



21
22
23
 
# File 'lib/funicular.rb', line 21

def configure
  yield configuration
end

.configure_debug ⇒ void

This method returns an undefined value.



24
 
# File 'sig/funicular.rbs', line 24

def self.configure_debug: () ?{ (self) -> void } -> void

.configure_forms ⇒ void

This method returns an undefined value.



21
 
# File 'sig/funicular.rbs', line 21

def self.configure_forms: () ?{ (Hash[Symbol, String]) -> void } -> void

.env ⇒ EnvironmentInquirer

Returns:



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

def self.env: () -> EnvironmentInquirer

.env= ⇒ EnvironmentInquirer?

Parameters:

Returns:



9
 
# File 'sig/funicular.rbs', line 9

def self.env=: (EnvironmentInquirer | String environment) -> EnvironmentInquirer?

.export_debug_config ⇒ void

This method returns an undefined value.



25
 
# File 'sig/funicular.rbs', line 25

def self.export_debug_config: () -> void

.first_element_child ⇒ JS::Element?

Parameters:

  • container_element (JS::Element)

Returns:

  • (JS::Element, nil) 


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

def self.first_element_child: (JS::Element container_element) -> JS::Element?

.form_builder_config ⇒ Hash[Symbol, String]?

Returns:

  • (Hash[Symbol, String], nil) 


22
 
# File 'sig/funicular.rbs', line 22

def self.form_builder_config: () -> Hash[Symbol, String]?

.form_builder_config= ⇒ Hash[Symbol, String]

Parameters:

  • config (Hash[Symbol, String])

Returns:

  • (Hash[Symbol, String]) 


23
 
# File 'sig/funicular.rbs', line 23

def self.form_builder_config=: (Hash[Symbol, String] config) -> Hash[Symbol, String]

.has_ssr_state? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.has_ssr_state?: () -> bool

.load_schemas ⇒ void

This method returns an undefined value.

Parameters:

  • models (Hash[singleton(Model), String]) 


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

def self.load_schemas: (Hash[singleton(Model), String] models) ?{ () -> void } -> void

.router ⇒ Router?

Returns:



10
 
# File 'sig/funicular.rbs', line 10

def self.router: () -> Router?

.server= ⇒ Boolean

Parameters:

  • value (Object)

Returns:

  • (Boolean) 


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

def self.server=: (untyped value) -> bool

.server? ⇒ Boolean

SSR / hydration support

Returns:

  • (Boolean) 


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

def self.server?: () -> bool

.start ⇒ void

This method returns an undefined value.

Parameters:

  • component_class (singleton(Component), nil)
  • container: (String, JS::Element)
  • props: (Hash[Symbol, untyped])
  • hydrate: (Boolean) 


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

def self.start: (?singleton(Component)? component_class, ?container: String | JS::Element, ?props: Hash[Symbol, untyped], ?hydrate: bool) ?{ (Router router) -> void } -> (Component | Router | nil)

.vendored_wasm_version ⇒ Object

Version of the @picoruby/wasm-wasi npm package whose builds are vendored under lib/funicular/vendor/picoruby/. Written by the funicular:vendor rake task at gem build time.



28
29
30
31
32
 
# File 'lib/funicular.rb', line 28

def vendored_wasm_version
  @vendored_wasm_version ||= File.read(File.join(VENDOR_PICORUBY_DIR, "VERSION")).strip
rescue Errno::ENOENT
  nil
end

.version ⇒ String

Returns:

  • (String) 


7
 
# File 'sig/funicular.rbs', line 7

def self.version: () -> String

.window_state ⇒ Hash[String, untyped]

Returns:

  • (Hash[String, untyped]) 


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

def self.window_state: () -> Hash[String, untyped]