API Reference petal_components v#4.0.5

Copy Markdown View Source

Modules

Importing use PetalComponents brings the core component set into scope as unqualified function components (<.button>, <.modal>, <.table>, …).

AI chat / conversation components — the LiveView-native answer to React's AI Elements / assistant-ui. Build streaming chat UIs without a client AI SDK: tokens stream over the LiveView socket you already have.

Everything related to forms: inputs, labels etc

For any helper functions used across multiple components. Ideally we keep this empty - components should be copy-pastable.

Icon name can be the function or passed in as a type eg.

Icon name can be the function or passed in as a type eg.

Renders pure inputs (no label or errors).

Pagination is the method of splitting up content into discrete pages. It specifies the total number of pages and inidicates to a user the current page within the context of total pages.

SVG helper components.

Everything related to text. Headings, paragraphs and links

A LiveView to test the accessibility of Petal Components using :a11y_audit.