ILIAS
trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
|
Describes a factory for file dropzones. More...
Public Member Functions | |
standard (string $title, string $message, string $post_url, FileInput $file_input, ?FormInput $additional_input=null,) | |
description: purpose: > The standard dropzone is used to drop files dragged from outside the browser window. More... | |
wrapper (string $title, string $post_url, $content, FileInput $file_input, ?FormInput $additional_input=null,) | |
description: purpose: > A wrapper dropzone is used to display other ILIAS UI components inside it. More... | |
Describes a factory for file dropzones.
Definition at line 31 of file Factory.php.
ILIAS\UI\Component\Dropzone\File\Factory::standard | ( | string | $title, |
string | $message, | ||
string | $post_url, | ||
FileInput | $file_input, | ||
?FormInput | $additional_input = null |
||
) |
description: purpose: > The standard dropzone is used to drop files dragged from outside the browser window.
The dropped files are presented to the user and can be uploaded to the server. composition: > Standard dropzones consist of a visible area where files can be dropped. They MUST contain a message explaining that it is possible to drop files inside. The dropped files are presented to the user in a roundtrip modal, which contains a file input. effect: > A standard dropzone is highlighted when the user is dragging files over the dropzone. After dropping, the dropped files are presented to the user with some meta information of the files such the file name and file size. rivals: Rival 1: > A wrapper dropzone can hold other ILIAS UI components instead of a message. Rival 2: > A file-input can be used instead of this component if other values have to be submitted at the same time. rules: accessibility: 1: > Standard dropzones MUST offer the possibility to select files
string | $title | |
string | $message | |
string | $post_url | |
FileInput | $file_input | |
FormInput | $additional_input |
Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\Factory.
ILIAS\UI\Component\Dropzone\File\Factory::wrapper | ( | string | $title, |
string | $post_url, | ||
$content, | |||
FileInput | $file_input, | ||
?FormInput | $additional_input = null |
||
) |
description: purpose: > A wrapper dropzone is used to display other ILIAS UI components inside it.
In contrast to the standard dropzone, the wrapper dropzone is not visible by default. Only the wrapped components are visible. Any wrapper dropzone gets highlighted once the user is dragging files over the browser window. Thus, a user needs to have the knowledge that there are wrapper dropzones present. They can be introduced to offer additional approaches to complete some workflow more conveniently. Especially in situation where space is scarce such as appointments in the calendar. composition: > A wrapper dropzone contains one or multiple ILIAS UI components. A roundtrip modal is used to present the dropped files and to initialize the upload process with a file input. effect: > All wrapper dropzones on the page are highlighted when the user dragging files over the browser window. After dropping the files, the roundtrip modal is opened showing all files. The modal contains a button to start the upload process. rivals: Rival 1: > A standard dropzone displays a message instead of other ILIAS UI components. rules: usage: 1: > Most pages SHOULD NOT contain a wrapper dropzone. Whenever you want to introduce a new usage of the Wrapper-Dropzone, propose it to the Jour Fixe. 2: Wrapper dropzones MUST contain one or more ILIAS UI components. 3: Wrapper dropzones MUST NOT contain any other file dropzones.
string | $title | |
string | $post_url | |
Component|Component[] | $content | |
FileInput | $file_input | |
FormInput | $additional_input |
Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\Factory.