API Reference PtahUI v#0.1.0

Copy Markdown View Source

Modules

PtahUI — Phoenix LiveView component library.

Alert component for informing users about important events.

Avatar component. Shows an image or generated initials with a deterministic background color.

Top-of-page announcement banner with optional countdown timer.

Button components: standard button, navigate button, action button, backoffice button, primary button, and secondary button.

LiveComponent for uploading a Curriculum Vitae (PDF/DOC/DOCX).

Calendar grid built entirely in Phoenix LiveView — no external JS.

Card and Badge components for presenting data and status.

Standalone styled checkbox input with size and color variants.

Countdown display showing months, days and hours remaining until a target date.

Divider component to separate content vertically or horizontally.

Dock (Bottom Navigation Bar) — sticks to the bottom of the screen and provides primary navigation options.

Dropdown menu with animated transitions, keyboard support, and click-away closing.

Conditionally renders content based on a user's permission map.

Floating Action Button (FAB) with Speed Dial.

Filter is a group of toggle buttons for exclusive selection.

A flexible link component that renders as <a>, <.link patch>, <.link navigate>, or <button>.

Form input components: text input, select, and checkbox. All components integrate with Phoenix.HTML.Form and changeset errors.

Hover Gallery — stacks images and reveals each one by hovering the corresponding invisible column over the container.

Renders a Heroicon by name as an inline CSS-mask span.

Drag-and-drop file uploader built on Phoenix LiveView's upload primitives.

Indicator component to place an element on the corner of another element.

Horizontal info display for presenting structured data.

Label components for enriched input fields.

Loading indicator with multiple animation styles and sizes.

Accessible modal dialog with animated transitions, focus trapping, and keyboard (Escape) / click-away closing.

Generic join-based pagination component — groups buttons with shared borders (the DaisyUI join pattern).

Progress bar component.

Rating component for collecting or displaying star/heart ratings.

Skeleton placeholder with shimmer animation for loading states.

Steps component for showing a list of steps in a process.

Swap — toggles visibility between two (or three) child elements using a hidden checkbox.

Data table with sortable columns, row click, actions, and pagination.

Search input that live-patches the URL with filter params compatible with Flop.

Tab navigation components: tabs container and individual tab.

Text Rotate — cycles through up to 6 text items with a slide-fade animation. The animation pauses on hover. Duration defaults to 10 seconds per full cycle.

Toggle is a checkbox styled as a switch button.

Tooltip that appears on hover around any element.