LedgerUI.Docs (LedgerUI v0.2.0)

Copy Markdown View Source

The installed components as data: modules, docs, attrs and slots.

Reads what the compiler recorded (__components__/0 of Phoenix.Component and the docs chunk), so it describes the code that is running. LedgerUI.Skill builds on it.

LedgerUI.Docs.components()
#=> [%{key: "accordion", module: LedgerUI.Components.Accordion, summary: "...",
#      moduledoc: "...", functions: [%{name: :accordion, doc: "...", attrs: [...],
#      global: %{...} | nil, slots: [...]}, ...]}, ...]

Summary

Functions

Every component module with at least one function component, sorted by key.

The snake_case key of a component module: LedgerUI.Components.ActionMenu is "action_menu".

Functions

components()

@spec components() :: [map()]

Every component module with at least one function component, sorted by key.

key(module)

@spec key(module()) :: String.t()

The snake_case key of a component module: LedgerUI.Components.ActionMenu is "action_menu".