Sets up an adapter that delegates every component to a fallback module, and optionally overrides specific components from a :components module.

Options

• :fallback — module providing the default implementations. Defaults to MishkaGervaz.UIAdapters.Tailwind.

• :components — module to source overrides from. Each component function is wired only when the target module is loaded and exports the corresponding 1-arity function.

• :nested_components — when true, look for each component under a submodule (e.g. Components.Button.button/1). When false (default), the components module is flat (e.g. Components.button/1).

• :module_prefix — a string prepended to each submodule name when nested_components: true. Example: "Mishka" makes the macro look under Components.MishkaButton.button/1.

• :component_prefix — a string prepended to each function name. Example: "mc_" makes the macro look up mc_button/1 on the target module.

Examples

# All defaults from Tailwind
defmodule MyAppWeb.UIAdapter do
  use MishkaGervaz.Behaviours.UIAdapter
end

# Flat components module — Components.button/1
defmodule MyAppWeb.UIAdapter do
  use MishkaGervaz.Behaviours.UIAdapter,
    components: MyAppWeb.Components
end

# Nested style — Components.Button.button/1
defmodule MyAppWeb.UIAdapter do
  use MishkaGervaz.Behaviours.UIAdapter,
    components: MyAppWeb.Components,
    nested_components: true
end

# Module prefix — Components.MishkaButton.button/1
defmodule MyAppWeb.UIAdapter do
  use MishkaGervaz.Behaviours.UIAdapter,
    components: MyAppWeb.Components,
    nested_components: true,
    module_prefix: "Mishka"
end

# Function prefix — Components.mc_button/1
defmodule MyAppWeb.UIAdapter do
  use MishkaGervaz.Behaviours.UIAdapter,
    components: MyAppWeb.Components,
    component_prefix: "mc_"
end

@spec component_functions() :: [atom()]

The list of every component function name on the behaviour. Useful for introspection and for tests that want to assert all functions are wired.

@spec resolve_target(atom(), module(), boolean(), String.t() | nil, String.t() | nil) ::
  {module(), atom()}

Resolves the {module, function} target a generated override should call, given the consuming module's :components, :nested_components, :module_prefix, and :component_prefix options.

Public so the macro can call it; also useful for testing the routing logic directly without having to build a full adapter.