PetalComponents.Showcase.Example (petal_components v4.11.2)

Copy Markdown View Source

One showcase example.

  • id - atom; on marketing pages this is also the section anchor
  • title / description - human copy shown above the preview
  • code - the exact HEEx source the author wrote (drives the "View Code" panel)
  • render - a (assigns -> rendered) function that produces the live preview
  • highlighted - optional precompiled, syntax-highlighted {:safe, html} for code; nil when no highlighter (mdex + lumis) was available at compile time
  • inert - render the preview non-interactive (the HTML inert attribute). For stateful-server examples whose fixed registry values cannot respond to clicks - the preview illustrates, the code panel teaches

Summary

Types

t()

Types

t()

@type t() :: %PetalComponents.Showcase.Example{
  code: String.t(),
  description: String.t() | nil,
  highlighted: {:safe, iodata()} | nil,
  id: atom(),
  inert: boolean(),
  render: (map() -> Phoenix.LiveView.Rendered.t()) | nil,
  title: String.t()
}