live_view_native
live_view_native
v0.1.2

LiveViewNative (live_view_native v0.1.2)

A module providing supporting functions for LiveView Native.

Summary

Functions

platform(platform_id)

Returns an environment struct for a LiveView Native platform given its platform_id or :error if not found.

platform!(platform_id)

Returns an environment struct for a LiveView Native platform given its platform_id or raises if not found.

platforms()

Returns a list of environment structs for all LiveView Native platforms.

Functions

Link to this function

platform(platform_id)

@spec platform(atom()) ::
  {:ok,
   %LiveViewNativePlatform.Env{
     custom_modifiers: term(),
     eex_engine: term(),
     modifiers: term(),
     modifiers_struct: term(),
     platform_config: term(),
     platform_id: term(),
     platform_modifiers: term(),
     render_macro: term(),
     tag_handler: term(),
     template_extension: term(),
     template_namespace: term()
   }}
  | :error

Returns an environment struct for a LiveView Native platform given its platform_id or :error if not found.

Used to introspect platforms at compile-time or runtime.

Link to this function

platform!(platform_id)

@spec platform!(atom()) :: %LiveViewNativePlatform.Env{
  custom_modifiers: term(),
  eex_engine: term(),
  modifiers: term(),
  modifiers_struct: term(),
  platform_config: term(),
  platform_id: term(),
  platform_modifiers: term(),
  render_macro: term(),
  tag_handler: term(),
  template_extension: term(),
  template_namespace: term()
}

Returns an environment struct for a LiveView Native platform given its platform_id or raises if not found.

Same as platform/1 but raises RuntimeError instead of returning :error if no platform exists for the given platform_id

Link to this function

platforms()

@spec platforms() :: [
  %LiveViewNativePlatform.Env{
    custom_modifiers: term(),
    eex_engine: term(),
    modifiers: term(),
    modifiers_struct: term(),
    platform_config: term(),
    platform_id: term(),
    platform_modifiers: term(),
    render_macro: term(),
    tag_handler: term(),
    template_extension: term(),
    template_namespace: term()
  }
]

Returns a list of environment structs for all LiveView Native platforms.