API Reference petal_components v3.0.0

View Source

Modules

PetalComponents
PetalComponents.Accordion
PetalComponents.Alert
PetalComponents.Avatar
PetalComponents.Badge
PetalComponents.Breadcrumbs
PetalComponents.Button
PetalComponents.ButtonGroup
PetalComponents.Card
PetalComponents.Container
PetalComponents.Dropdown
PetalComponents.Field
PetalComponents.Form

Everything related to forms: inputs, labels etc

PetalComponents.Helpers

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

PetalComponents.HeroiconsV1.Outline

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

PetalComponents.HeroiconsV1.Solid

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

PetalComponents.Icon
PetalComponents.Input

Renders pure inputs (no label or errors).

PetalComponents.Link
PetalComponents.Loading
PetalComponents.Marquee
PetalComponents.Menu
PetalComponents.Modal
PetalComponents.Pagination

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.

PetalComponents.PaginationInternal
PetalComponents.Progress
PetalComponents.Rating
PetalComponents.Skeleton
PetalComponents.SlideOver
PetalComponents.Stepper
PetalComponents.Svg

SVG helper components.

PetalComponents.Table
PetalComponents.Tabs
PetalComponents.Typography

Everything related to text. Headings, paragraphs and links

PetalComponents.UserDropdownMenu
PetalComponentsWeb.A11yLive

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