spz-order-shipment 订单物流

支持布局: container

何时使用

需要展示订单物流,一般用在订单详情页面。

代码演示

基本用法

该组件将业务逻辑都封装起来,我们可以直接使用封装好的数据来展示物流详情。

模版数据

需要多语言的数据都组件内部都支持了多语言,可以直接使用。(只包含组件处理过的数据,原接口数据不变)

物流包裹数据:

属性名说明类型
count当前物流包裹数number
fulfillments物流详情Array
fulfillments[0].shippingStatus物流状态string
fulfillments[0].showConfirmReceiptBtn是否要展示确认收据按钮boolean
fulfillments[0].showTrackingInfoBtn是否要展示跟踪物流信息按钮boolean
fulfillments[0].showCustomTrackingInfo是否要展示自定义的跟踪物流信息按钮boolean
fulfillments[0].parsedTime订单日期解析对象Object
fulfillments[0].line_items商品详情数组Array
fulfillments[0].line_items[0].parsedProperties解析商品数据里的 properties 属性为一个对象Object
fulfillments[0].line_items[0].optionValueJoinInSlash将商品数据里的 options 数组的值取出来用 / 分隔展示,例如:black / Lstring
fulfillments[0].line_items[0].optionsJoinInColon将商品数据里的 options 数组的名/值格式为 name: value 形式,例如:color: blackArray

parsedTime 对象数据

属性名描述输出
YYYY四位数的年份2023
M月份,从1开始1-12
MM月份,两位数01-12
MMM缩写的月份名称Jan-Dec
D月份里的一天1-31
DD月份里的一天,两位数01-31
ddd缩写的星期名称Mon-Sun
H小时0-23
HH小时,两位数00-23
h小时,12小时制1-12
hh小时,12小时制,两位数01-12
m分钟0-59
mm分钟,两位数00-59
s0-59
ss秒,两位数00-59
a上午或下午,小写am | pm
A上午或下午,大写AM | PM

parsedProperties 对象数据

属性名描述类型
name自定义属性名称string
value自定义属性值any
isImage自定义属性值是否是图片类型boolean

spz-render带有role="tracking-info-render"属性的模版数据:

属性名说明类型
tag物流状态string
carrierName物流商名称,例如:USPSstring
trackingNumber物流单号string
checkpoints物流到达每个检查点的信息Array
tagInfo物流状态信息,例如:Delivered on Feb 15, Wedstring
primaryColor十六进制的主色string
width当前物流进度的百分比string

执行各种操作的按钮需要配置对应的 role 属性值来赋予当前按钮对应的能力,支持以下几种行为能力:

描述
tracking点击按钮,如果物流单号不是 Aftership 类型的,就渲染带有 role="tracking-info-render"spz-render 元素,并给予包裹相关的物流信息。该按钮必须带有 tracking-id 属性,值是物流单号 和 target-id 属性,值为带有 role="tracking-info-render" 属性的 spz-render 元素的作为子元素的元素ID
confirm_receipt点击按钮,打开确认收货当前订单警告对话框,如果点击对话框的确认按钮,确认收货。该按钮必须带有 data-id 属性,值为物流ID
<spz-order-shipment layout="container" order-id="xxx">
  <template>
    <div>
      <h3>Shipments</h3>
      <!-- Shipment Information ... -->

      <!-- Tracking buttons -->
      <div>
        <button
          id="shipment-tracking-btn"
          role="tracking"
          tracking-id="${item.tracking_number}"
          target-id="shipment-tracking-wrapper"
        >
          Tracking info
        </button>
        <button role="confirm_receipt" data-id="${item.id}">
          Confirm receipt
        </button>
      </div>

      <!-- Tracking info -->
      <div id="shipment-tracking-wrapper">
        <spz-render role="tracking-info-render" manual layout="container" template="shipment-tracking-detail-template"></spz-render>
      </div>
    </div>
  </template>
</spz-order-shipment>

属性

属性名说明类型默认值是否必需
order-id订单IDstring-

AI 摘要(LLM Ready)

  • 组件标识spz-order-shipment
  • 用途一句话:展示订单物流。
  • 可识别属性条目:1
  • 可识别方法小节:0
  • 可识别事件小节:0
  • 关键属性名(Top)order-id
  • 关键方法名(Top):无(待补充)
  • 关键事件名(Top):无(待补充)
  • 阅读顺序建议:先看「何时使用」与「代码演示」,再核对属性/方法/事件。
  • 关联文档/guide/actions-and-events//guide/layouts/