processton-io/processton-interaction

This package will generate interaction

1.0.0 2024-05-20 07:40 UTC

Requires

• php: ^8.0|^8.1

Requires (Dev)

• orchestra/testbench: ^8.0
• phpunit/phpunit: ^9.0

MIT

• Ahmad Faryab Kokab

• processton
• processton-io
• processton-interaction

README

The Processton Interaction package is a tool for generating array structures used in the Processton client. It provides a convenient way to handle interactions between different components of the Processton system. With this package, you can easily create and manage complex data structures for seamless communication within your application.

Installation

You can install the package via composer:

composer require processton-io/processton-interaction

Usage

width

This method is used to set the width of an element.

Parameters:

• $sm, $lg, $md: Width for different screen sizes.
• $additional (optional): Additional parameters.

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

This method is used to generate breadcrumbs.

Parameters:

• $breadcrumbs: An array of breadcrumb items.

ProcesstonElements::generateBreadCrumbs(...$breadcrumbs)

generateBreadCrumbItem

This method is used to generate a breadcrumb item.

Parameters:

• $label: The label of the breadcrumb item.
• $slug: The slug of the breadcrumb item.
• $icon (optional): The icon of the breadcrumb item.

ProcesstonElements::generateBreadCrumbItem(
    $label,
    $slug,
    $icon = ''
)

generateInteraction

This method is used to generate an interaction.

Parameters:

• $title: The title of the interaction.
• $slug: The slug of the interaction.
• $subTitle (optional): The subtitle of the interaction.
• $icon (optional): The icon of the interaction.
• $breadcrumbs (optional): The breadcrumbs of the interaction.
• $filters (optional): The filters of the interaction.
• $elements (optional): The elements of the interaction.

ProcesstonElements::generateInteraction(
    $title,
    $slug,
    $subTitle,
    $icon,
    $breadcrumbs,
    $filters,
    $elements
)

generateRow

This method is used to generate a row.

Parameters:

• $elements: The elements of the row.
• $width (optional): The width of the row.

ProcesstonElements::generateRow(
    $elements,
    $width
)

generateElement

This method is used to generate an element with the provided parameters.

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

Parameters:

• $type: The type of the element.
• $title: The title of the element.
• $data: The data of the element.
• $subTitle (optional): The subtitle of the element.
• $attachments (optional): The attachments of the element.
• $elements (optional): The elements of the element.
• $width (optional): The width of the element.
• $name (optional): The name of the element.

generateElementByUrl

This method is used to generate an element by URL with the provided parameters.

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

Parameters:

• $dataSrc: The data source URL of the element.
• $title (optional): The title of the element.
• $subTitle (optional): The subtitle of the element.
• $type (optional): The type of the element.
• $attachments (optional): The attachments of the element.
• $elements (optional): The elements of the element.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Ahmad Faryab Kokab
• All Contributors

License

The MIT License (MIT). Please see License File for more information.