PhoenixKitWarehouse.Web.Components.CommentsPanel (PhoenixKitWarehouse v0.1.0)

Copy Markdown View Source

Presentation helper for warehouse document comment threads. panel/1 embeds the ready-made PhoenixKitComments.Web.CommentsComponent.

Consolidates what were 5 near-identical files in Andi (AndiWeb.Components.{InternalOrder,GoodsIssue,GoodsReceipt,SupplierOrder, Inventory}Comments, under lib/andi_web/components/ — distinct from the 5 context wrapper modules of the same base names that PhoenixKitWarehouse.Comments already consolidates) into one module parameterized by kind, mirroring PhoenixKitWarehouse.Comments' own kind :: :goods_issue | :goods_receipt | :internal_order | :supplier_order | :inventory parameterization.

Callers guard visibility with PhoenixKitWarehouse.Comments.available?/0.

Summary

Functions

panel(assigns)

Embedded comments thread for a warehouse document.

Functions

panel(assigns)

Embedded comments thread for a warehouse document.

Assigns:

  • :kind — :goods_issue | :goods_receipt | :internal_order | :supplier_order | :inventory (required)

  • :resource_uuid — the document's uuid, used as resource_uuid (required)
  • :current_user — current user struct (or nil) (required)
  • :id — optional DOM id; defaults to comments-<kind>-<uuid>
  • :title — optional heading; defaults to ""
  • :read_only — when true, render without composer or chrome

Attributes

  • kind (:atom) (required) - Must be one of :goods_issue, :goods_receipt, :internal_order, :supplier_order, or :inventory.
  • resource_uuid (:string) (required)
  • current_user (:any) (required)
  • id (:string) - Defaults to nil.
  • title (:string) - Defaults to "".
  • read_only (:boolean) - Defaults to false.