processton-io/processton-interaction

1.0.0 2024-05-20 07:40 UTC

This package is auto-updated.

Last update: 2024-09-20 08:28:10 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

Processton Interaction 包是一个用于生成 Processton 客户端使用的数组结构的工具。它提供了一种方便的方式来处理 Processton 系统不同组件之间的交互。使用此包,您可以轻松创建和管理复杂的数据结构,以实现应用程序内部的无缝通信。

安装

您可以通过 composer 安装此包

composer require processton-io/processton-interaction

用法

宽度

此方法用于设置元素的宽度。

参数

  • $sm, $lg, $md: 不同屏幕尺寸的宽度。
  • $additional (可选): 额外参数。
ProcesstonElements::width(
    $SM_Widh,
    $MD_Widh,
    $LG_Width,
    $AditioalSizes = [
        'xxxs' => $XXXS_Width,
        'xxs' => $XXS_Width,
        'xs' => $XS_Width,
        'xl' => $XL_Width,
        'xxl' => $XXL_Width,
        'xxxl' => $XXXL_Width
    ]
)

generateBreadCrumbs

此方法用于生成面包屑。

参数

  • $breadcrumbs: 面包屑项数组。
ProcesstonElements::generateBreadCrumbs(...$breadcrumbs)

generateBreadCrumbItem

此方法用于生成面包屑项。

参数

  • $label: 面包屑项的标签。
  • $slug: 面包屑项的别名。
  • $icon (可选): 面包屑项的图标。
ProcesstonElements::generateBreadCrumbItem(
    $label,
    $slug,
    $icon = ''
)

generateInteraction

此方法用于生成交互。

参数

  • $title: 交互的标题。
  • $slug: 交互的别名。
  • $subTitle (可选): 交互的副标题。
  • $icon (可选): 交互的图标。
  • $breadcrumbs (可选): 交互的面包屑。
  • $filters (可选): 交互的过滤器。
  • $elements (可选): 交互的元素。
ProcesstonElements::generateInteraction(
    $title,
    $slug,
    $subTitle,
    $icon,
    $breadcrumbs,
    $filters,
    $elements
)

generateRow

此方法用于生成一行。

参数

  • $elements: 行的元素。
  • $width (可选): 行的宽度。
ProcesstonElements::generateRow(
    $elements,
    $width
)

generateElement

此方法用于根据提供的参数生成元素。

ProcesstonElements::generateElement(
    $type, 
    $title, 
    $data, 
    $subTitle, 
    $attachments, 
    $elements,
    $widthe,
    $name,
)

参数

  • $type: 元素的类型。
  • $title: 元素的标题。
  • $data: 元素的数据。
  • $subTitle (可选): 元素的副标题。
  • $attachments (可选): 元素的附件。
  • $elements (可选): 元素的元素。
  • $width (可选): 元素的宽度。
  • $name (可选): 元素的名字。

generateElementByUrl

此方法用于通过 URL 使用提供的参数生成元素。

ProcesstonElements::generateElementByUrl(
    $dataSrc,
    $title,
    $subTitle,
    $type,
    $attachments,
    $elements,
)

参数

  • $dataSrc: 元素的数据源 URL。
  • $title (可选): 元素的标题。
  • $subTitle (可选): 元素的副标题。
  • $type (可选): 元素的类型。
  • $attachments (可选): 元素的附件。
  • $elements (可选): 元素的元素。

测试

composer test

变更日志

有关最近更改的更多信息,请参阅 变更日志

贡献

有关详细信息,请参阅 贡献指南

安全

如果您发现任何安全相关的问题,请通过电子邮件 ahmadkokab@gmail.com 联系,而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件