Skip to content

docs: rewrite README with comprehensive API documentation#24

Merged
cristinecula merged 1 commit intomainfrom
docs/readme
Feb 12, 2026
Merged

docs: rewrite README with comprehensive API documentation#24
cristinecula merged 1 commit intomainfrom
docs/readme

Conversation

@cristinecula
Copy link
Contributor

Summary

  • Replaces the near-empty README ("A pionjs component") with comprehensive documentation covering the full API surface
  • All examples are production-inspired, based on real usage patterns from cosmoz-frontend (purchase procurement views)
  • Documents the 4 main entry points: main queue, actions, list, and fetch utilities

Documentation structure

Section Content
Quick start queue() factory with typed example showing details, list, view, loader pattern
View modes Explanation of list/split/queue tabs, URL hash sync, mobile behavior
List module listCore(), column(), useListCore(), useListCoreState() with full examples
Actions module action(), renderActions(), defaultButton() with dialog integration examples
Advanced hooks useQueue() + renderQueue() composition, individual hooks reference table
Utilities Fetch helpers (setBaseInit, handleJSON, RequestError), itemClick(), getItems(), touch()
Architecture ASCII diagram of the internal composition tree
Entry points Reference table mapping all import paths to their exports

@github-actions
Copy link

github-actions bot commented Feb 12, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-02-12 08:41 UTC

@cristinecula cristinecula self-assigned this Feb 12, 2026
@cristinecula cristinecula marked this pull request as ready for review February 12, 2026 08:37
@cristinecula cristinecula merged commit 1da1ea0 into main Feb 12, 2026
3 checks passed
@github-actions
Copy link

🎉 This PR is included in version 1.6.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants