Attachment
Overview
Attachment は選択もしくはドラッグ&ドロップでファイルをアップロードすることができます。
Specification
Property
使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。
| Name | Type | Default | Description | Remark |
|---|---|---|---|---|
| className | string | "" | コンポーネントの class 名 | |
| error | string | "" | エラーに表示するテキスト | 未指定、あるいは空文字の場合、error は表示されない |
| id | string | "" | コンポーネントの id 名 | |
| label | string | "" | コンポーネントの説明ラベル | 未指定、あるいは空文字の場合、label は表示されない |
| language *1 | string | "auto" | 言語設定 | 指定できるオプション: "auto", "en", "ja", "zh", "zh-TW" "auto" を指定した場合、HTML の lang 設定に従う（lang 設定が "en"/"zh"/"zh-TW"/"ja" 以外の場合は、言語設定が "en" になる） |
| message | string | "" | コンポーネントに表示するメッセージ（file type/size の制限事項など） | |
| disabled | boolean | false | コンポーネントの選択可/不可設定 | |
| requiredIcon | boolean | false | コンポーネントの必須アイコン表示/非表示設定 | |
| visible | boolean | true | コンポーネントの表示/非表示設定 | |
| files | Array<File> | [] | ファイルリスト | File objectもしくは name と size を含むオブジェクトを指定できる files が配列以外の場合、エラーを出力する |
備考
*1: "参照" ボタンと "ここにファイルをドロップします" のテキストは language プロパティの値に応じて切り替わる.
File
| Name | Type | Default | Description | Remark |
|---|---|---|---|---|
| name | string | "" | ファイル名 | |
| size | string | "" | ファイルサイズ | ファイルサイズに応じて以下のように記載される |
Event
指定できるイベントの一覧です。
| Name | Type | Description | Remark |
|---|---|---|---|
| change | function | ファイルが変更された時のイベントハンドラ | 引数には Event の event オブジェクトをとる event.detail で以下の値を受け取ることができる
|
Constructor
Attachment(options)
使用できるコンストラクタの一覧です。
Parameter
| Name | Type | Default | Description | Remark |
|---|---|---|---|---|
| options | object | {} | コンポーネントのプロパティを含むオブジェクト |
Custom CSS
ヒント
Custom CSS をご確認ください。
コンポーネントのスタイルを変更するために使用できるプロパティの一覧です。
Property
| Name |
|---|
| --kuc-attachment-width |
| --kuc-attachment-height |
| --kuc-attachment-item-font-size |
| --kuc-attachment-message-font-size |
| --kuc-attachment-message-color |
Sample Code
ヒント
導入と実装方法 をご確認ください。
全てのパラメータを指定した場合のサンプルコードです。
const Kuc = Kucs['1.x.x'];
const space = kintone.app.record.getSpaceElement('space');
const attachment = new Kuc.Attachment({
label: 'Attachment',
files: [
{ name: 'file.txt', size: '150' },
new File(['foo'], 'foo.txt', { type: 'text/plain' })
],
language: 'auto',
message: 'Max size: 50MB',
error: 'Error occurred!',
className: 'options-class',
id: 'options-id',
visible: true,
disabled: false,
requiredIcon: false
});
space.appendChild(attachment);
attachment.addEventListener('change', event => {
console.log(event);
});