# PtahUI v0.1.0 - Table of Contents

> A Phoenix LiveView component library

## Pages

- [README](readme.md)

## Modules

- [PtahUi](PtahUi.md): PtahUI — Phoenix LiveView component library.
- [PtahUi.Components.Alert](PtahUi.Components.Alert.md): Alert component for informing users about important events.
- [PtahUi.Components.Avatar](PtahUi.Components.Avatar.md): Avatar component. Shows an image or generated initials with a deterministic background color.

- [PtahUi.Components.Banner](PtahUi.Components.Banner.md): Top-of-page announcement banner with optional countdown timer.
- [PtahUi.Components.CVUpload](PtahUi.Components.CVUpload.md): LiveComponent for uploading a Curriculum Vitae (PDF/DOC/DOCX).
- [PtahUi.Components.Calendar](PtahUi.Components.Calendar.md): Calendar grid built entirely in Phoenix LiveView — no external JS.
- [PtahUi.Components.Carousel](PtahUi.Components.Carousel.md)
- [PtahUi.Components.Checkbox](PtahUi.Components.Checkbox.md): Standalone styled checkbox input with size and color variants.
- [PtahUi.Components.Countdown](PtahUi.Components.Countdown.md): Countdown display showing months, days and hours remaining until a target date.
- [PtahUi.Components.Divider](PtahUi.Components.Divider.md): Divider component to separate content vertically or horizontally.
- [PtahUi.Components.Dock](PtahUi.Components.Dock.md): Dock (Bottom Navigation Bar) — sticks to the bottom of the screen and
provides primary navigation options.
- [PtahUi.Components.Dropdown](PtahUi.Components.Dropdown.md): Dropdown menu with animated transitions, keyboard support, and click-away closing.
- [PtahUi.Components.EnsurePermissions](PtahUi.Components.EnsurePermissions.md): Conditionally renders content based on a user's permission map.
- [PtahUi.Components.Fab](PtahUi.Components.Fab.md): Floating Action Button (FAB) with Speed Dial.
- [PtahUi.Components.Filter](PtahUi.Components.Filter.md): Filter is a group of toggle buttons for exclusive selection.
- [PtahUi.Components.FlexLink](PtahUi.Components.FlexLink.md): A flexible link component that renders as `<a>`, `<.link patch>`, `<.link navigate>`, or `<button>`.
- [PtahUi.Components.HoverGallery](PtahUi.Components.HoverGallery.md): Hover Gallery — stacks images and reveals each one by hovering
the corresponding invisible column over the container.
- [PtahUi.Components.Icon](PtahUi.Components.Icon.md): Renders a Heroicon by name as an inline CSS-mask span.
- [PtahUi.Components.ImageUploader](PtahUi.Components.ImageUploader.md): Drag-and-drop file uploader built on Phoenix LiveView's upload primitives.
- [PtahUi.Components.Indicator](PtahUi.Components.Indicator.md): Indicator component to place an element on the corner of another element.
- [PtahUi.Components.InfoDisplay](PtahUi.Components.InfoDisplay.md): Horizontal info display for presenting structured data.
- [PtahUi.Components.Label](PtahUi.Components.Label.md): Label components for enriched input fields.
- [PtahUi.Components.Loading](PtahUi.Components.Loading.md): Loading indicator with multiple animation styles and sizes.
- [PtahUi.Components.Pagination](PtahUi.Components.Pagination.md): Generic join-based pagination component — groups buttons with shared borders
(the DaisyUI `join` pattern).
- [PtahUi.Components.Progress](PtahUi.Components.Progress.md): Progress bar component.
- [PtahUi.Components.Rating](PtahUi.Components.Rating.md): Rating component for collecting or displaying star/heart ratings.
- [PtahUi.Components.Skeleton](PtahUi.Components.Skeleton.md): Skeleton placeholder with shimmer animation for loading states.
- [PtahUi.Components.Steps](PtahUi.Components.Steps.md): Steps component for showing a list of steps in a process.
- [PtahUi.Components.Swap](PtahUi.Components.Swap.md): Swap — toggles visibility between two (or three) child elements using a hidden checkbox.
- [PtahUi.Components.Table](PtahUi.Components.Table.md): Data table with sortable columns, row click, actions, and pagination.
- [PtahUi.Components.TableSearch](PtahUi.Components.TableSearch.md): Search input that live-patches the URL with filter params compatible with Flop.
- [PtahUi.Components.Tabs](PtahUi.Components.Tabs.md): Tab navigation components: tabs container and individual tab.
- [PtahUi.Components.TextRotate](PtahUi.Components.TextRotate.md): 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.
- [PtahUi.Components.Timeline](PtahUi.Components.Timeline.md)
- [PtahUi.Components.Toggle](PtahUi.Components.Toggle.md): Toggle is a checkbox styled as a switch button.
- [PtahUi.Components.Tooltip](PtahUi.Components.Tooltip.md): Tooltip that appears on hover around any element.

- Components
  - [PtahUi.Components.Button](PtahUi.Components.Button.md): Button components: standard button, navigate button, action button,
backoffice button, primary button, and secondary button.
  - [PtahUi.Components.Card](PtahUi.Components.Card.md): Card and Badge components for presenting data and status.

  - [PtahUi.Components.Form](PtahUi.Components.Form.md): Form input components: text input, select, and checkbox.
All components integrate with `Phoenix.HTML.Form` and changeset errors.

  - [PtahUi.Components.Modal](PtahUi.Components.Modal.md): Accessible modal dialog with animated transitions, focus trapping, and
keyboard (Escape) / click-away closing.

