lyrasoft/attachment

LYRASOFT attachment package

1.0.5 2023-12-22 07:29 UTC

Requires

• lyrasoft/luna: ^1.0||^2.0
• myclabs/php-enum: ^1.8

MIT

• chokeslam

README

安裝

composer require lyrasoft/attachment

需要更改 mig、entity、repo時可複製出來

php windwalker pkg:install lyrasoft/attachment -t migrations -t entity -t attachment_modal

使用

先到 unicorn.php 中註冊 AttachmentPackage

'unicorn' => [
        
        .....

        'providers' => [
            \Lyrasoft\Attachment\AttachmentPackage::class,
        ],
]

<x-attachment-field 
    :items="$attachments"
    :insertBtn="true"
    :accept="'pdf,gif'"
    >
</x-attachment-field>

Options

name	require	Desc
id	false	欄位 id，預設帶隨機碼，需要 JS 控制可以自訂
name	false	欄位名稱，會自動後綴 []，預設是 attachments
items	true	提供已上傳檔案列表做使用
insertBtn	false	插入文章的btn，可以是 true 或 Tinymce element 的選擇器
accept	false	限制檔案類型

如果要單獨使用 檔案列表 或是 上傳Input的話 也可以單獨使用

<!-- 一般使用，啟動插入文章功能。預設會指定 #input-tiem-fulltext -->
<x-attachment-field :items="$attachments" :insertBtn="true"></x-attachment-field>

<!-- 一般使用，啟動插入文章功能。自訂 Tinymce id -->
<!-- 插入 file-drag 專屬 options -->
<x-attachment-field :options="$options" insertBtn="#input-item-content"></x-attachment-field>

<!-- 頁面上插入第二組時，可以自訂另一個 name -->
<!-- id 也可以自訂，如果沒自訂，會用隨機碼，不會衝突 -->
<x-attachment-field
    id="input-attachments-other"
    name="othert_attachments"
    :options="$options" 
    insertBtn="#input-item-content"></x-attachment-field>

CSS / JS

插入 attachment 元件後，就會自行插入，如果需要手動引入，可以下面程式碼

$asset->css('vendor/lyrasoft/attachment/dist/attachment.min.css');
$asset->js('vendor/lyrasoft/attachment/dist/attachment.min.js');

Slot

如果你想自訂額外的按鈕的動作，可以用 buttons slot

        <x-attachment-field :items="$attachments">
            <x-slot name="buttons">
                @scope($item, $i)
               
                Do anything with $item
            </x-slot>
        </x-attachment-field>

元件個別引入

• <attachment-field>: 最完整的元件，包含 list & uploader
• <attachment-uploader>: 使用 file-drag 做的上傳器
• <attachment-list>: 上傳附件列表

備註

1. 記得要在 view 中利用repo 或是 ORM 取出 attachments 並塞入 field 的 option 中。
2. 在controller 內記得寫儲存及刪除的內容, 有刪除檔案的話可以從 $app->input() 中取得 remove_attachments 裡面是 attachment 的 ID