File
<et2-file> | Et2File
Displays a button to select files to upload
<et2-file
multiple
image="cloud-upload"
label="Select files to upload"
helpText="Please check your files are complete before uploading"
></et2-file>
File allows the user to upload files to EGroupware. The uploaded files are processed on the server when the form is submitted. As files are selected, they will be shown in a list with FileItem
Examples
Icon
Use image to specify the icon
<et2-file image="cloud-upload" ></et2-file>
Limit files allowed
Use the multiple, allow, maxFiles and
maxFileSize attributes to place restrictions on the files to be uploaded.
<et2-file image="image" allow="image/*" label="Choose an image"></et2-file>
<et2-file image="images" allow="image/*" multiple label="Choose images"></et2-file>
<et2-file maxFiles="3" label="Max. 3 files"></et2-file>
<et2-file maxFileSize="10000" label="Small files only"></et2-file>
Inline
Normally the selected files are listed in a dropdown to avoid changing the flow of the rest of the page. Set
inline to not do that
<et2-file label="Choose an image" inline></et2-file>
Display
Use the display attribute for different ways of showing results
<et2-file display="small" label="Small">
<et2-file-item slot="list" size="654321000" display="small" closable>Small file</et2-file-item>
</et2-file>
<et2-file display="list" label="List">
<et2-file-item slot="list" size="1234567" display="list" closable>File(s) shown as list</et2-file-item>
</et2-file>
Slots
| Name | Description |
|---|---|
image
|
The component’s image |
label
|
Button label |
prefix
|
Used to prepend a presentational icon or similar element before the button. |
suffix
|
Used to append a presentational icon or similar element after the button. |
help-text
|
Text that describes how to use the input. Alternatively, you can use the help-text attribute. |
button
|
A button to use in lieu of the default button |
list
|
Selected files are listed here. Place something in this slot to override the normal file list. |
Learn more about using slots.
Properties
| Name | Description | Reflects | Type | Default |
|---|---|---|---|---|
accept
|
A string that defines the file types the file dropzone should accept. Defaults to all. |
|
string
|
""
|
accesskey
|
Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. |
|
string
|
- |
actions
|
Set Actions on the widget Each action is defined as an object: move: { type: “drop”, acceptedTypes: “mail”, icon: “move”, caption: “Move to” onExecute: javascript:mail_move” } This will turn the widget into a drop target for “mail” drag types. When “mail” drag types are dropped, the global function mail_move(egwAction action, egwActionObject sender) will be called. The ID of the dragged “mail” will be in sender.id, some information about the sender will be in sender.context. The etemplate2 widget involved can typically be found in action.parent.data.widget, so your handler can operate in the widget context easily. The location varies depending on your action though. It might be action.parent.parent.data.widget To customise how the actions are handled for a particular widget, override _link_actions(). It handles the more widget-specific parts. |
object
|
- | |
align
|
Used by Et2Box to determine alignment. Allowed values are left, right |
|
string
|
- |
autofocus
|
Have browser focus this input on load. Overrides etemplate2.focusOnFirstInput(), use only once per page https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attributes |
|
boolean
|
- |
chunkSize
|
Chunk size can be altered by the server | - | - | |
class
|
CSS Class. This class is applied to the outside, on the web component itself. Due to how WebComponents work, this might not change anything inside the component. |
|
string
|
- |
data
|
Set the dataset from a CSV |
string
|
- | |
deferredProperties
|
Any attribute that refers to row content cannot be resolved immediately, but some like booleans cannot stay a string because it’s a boolean attribute. We store them for later, and parse when they’re fully in their row. If you are creating a widget that can go in a nextmatch row, and it has boolean attributes that can change for each row, add those attributes into deferredProperties | - | - | |
disabled
|
Defines whether this widget is visibly disabled. The widget is still visible, but clearly cannot be interacted with. Widgets disabled in the template will not return a value to the application code, even if re-enabled via javascript before submitting. To allow a disabled widget to be re-enabled and return a value, disable via javascript in the app’s et2_ready() instead of an attribute in the template file. |
|
boolean
|
false
|
dom_id
|
Get the actual DOM ID, which has been prefixed to make sure it’s unique. |
string
|
- | |
dropTarget
|
Component to listen for file drops |
string
|
- | |
fileListTarget
|
Target element to show file list in instead of the default dropdown |
string
|
- | |
hasFeedbackFor
|
Get a list of feedback types |
string[]
|
- | |
hidden
|
The widget is not visible. As far as the user is concerned, the widget does not exist. Widgets hidden with an attribute in the template may not be created in the DOM, and will not return a value. Widgets can be hidden after creation, and they may return a value if hidden this way. |
|
boolean
|
- |
id
|
Get the ID of the widget |
string
|
- | |
image
|
The button’s image |
string
|
"paperclip"
|
|
inline
|
Show the files inline instead of floating over the rest of the page. This can cause the page to reflow |
boolean
|
false
|
|
label
|
The label of the widget Legacy support for labels with %s that get wrapped around the widget Not the best way go with webComponents - shouldn’t modify their DOM like this |
string
|
- | |
loading
|
Draws the item in a loading state. |
|
boolean
|
false
|
maxFiles
max-files
|
The maximum amount of files that are allowed. |
number
|
- | |
maxFileSize
max-file-size
|
An optional maximum size of a file that will be considered valid. |
number | undefined
|
- | |
multiple
|
Indicates if multiple files can be uploaded |
|
boolean
|
false
|
noFileList
no-file-list
|
If true, no file list will be shown |
|
boolean
|
false
|
noLang
|
Disable any translations for the widget |
boolean
|
- | |
parentId
|
Parent is different than what is specified in the template / hierarchy. Widget ID of another node to insert this node into instead of the normal location |
string
|
- | |
statustext
|
Tooltip which is shown for this element on hover |
|
string
|
- |
styles
|
WebComponent * | - | - | |
translate
|
List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing. | - | - | |
uploadTarget
|
Server path to receive uploaded file |
string
|
"EGroupware\Api\Etemplate\Widget\File::ajax_upload"
|
|
value
|
Files already uploaded |
{ [tempFileName : string] : FileInfo }
|
- | |
needed
|
Compatibility for deprecated name “needed”
use required instead |
- | - | |
options
|
Get property-values as object
use widget methods |
object
|
- | |
readOnly
|
Lion mapping
true |
- | - | |
supportedWidgetClasses
|
et2_widget compatability
Legacy compatability. Some legacy widgets check their parent to see whats allowed |
array
|
[]
|
|
updateComplete |
A read-only promise that resolves when the component has finished updating. |
Learn more about attributes and properties.
Events
| Name | React Event | Description | Event Detail |
|---|---|---|---|
change |
Emitted when all selected files are complete |
CustomEvent
|
|
et2-add |
Emitted when a file is added | - | |
et2-load |
Emitted when file is complete | - |
Learn more about events.
Methods
| Name | Description | Arguments |
|---|---|---|
checkCreateNamespace()
|
Checks whether a namespace exists for this element in the content array. If yes, an own perspective of the content array is created. If not, the parent content manager is used. Constructor attributes are passed in case a child needs to make decisions | - |
clone()
|
Creates a copy of this widget. |
_parent: et2_widget
|
createElementFromNode()
|
Create a et2_widget from an XML node. First the type and attributes are read from the node. Then the readonly & modifications arrays are checked for changes specific to the loaded data. Then the appropriate constructor is called. After the constructor returns, the widget has a chance to further initialize itself from the XML node when the widget’s loadFromXML() method is called with the node. |
_node: , _name:
|
et2HandleBlur()
|
If the value is unchanged, put any held validation messages back Named et2HandleBlur to avoid overwriting handleBlur() in Shoelace components |
_ev: FocusEvent
|
et2HandleFocus()
|
When input receives focus, clear any validation errors. If the value is the same on blur, we’ll put them back The ones from the server (ManualMessage) can interfere with submitting. Named et2HandleFocus to avoid overwriting handleFocus() in Shoelace components |
_ev: FocusEvent
|
getArrayMgr()
|
Returns the array manager object for the given part |
managed_array_type: string
|
getArrayMgrs()
|
Returns an associative array containing the top-most array managers. |
_mgrs: object
|
getChildren()
|
Get child widgets Use |
- |
getInputNode()
|
Get input to e.g. set aria-attributes | - |
getInstanceManager()
|
Returns the instance manager | - |
getPath()
|
Returns the path into the data array. By default, array manager takes care of this, but some extensions need to override this | - |
getRoot()
|
Returns the base widget Usually this is the same as getInstanceManager().widgetContainer | - |
isValid()
|
Used by etemplate2 to determine if we can submit or not |
messages:
|
loadFromXML()
|
Loads the widget tree from an XML node |
_node:
|
loadingFinished()
|
Needed for legacy compatability. |
promises: Promise[]
|
parseXMLAttrs()
|
The parseXMLAttrs function takes an XML DOM attributes object and adds the given attributes to the _target associative array. This function also parses the legacyOptions. N.B. This is only used for legacy widgets. WebComponents use transformAttributes() and do their own handling of attributes. |
_attrsObj: , _target: object, _proto: et2_widget
|
set_label()
|
NOT the setter, since we cannot add to the DOM before connectedCallback() TODO: This is not best practice. Should just set property, DOM modification should be done in render https://lit-element.polymer-project.org/guide/templates#design-a-performant-template |
value: string
|
setArrayMgr()
|
Sets the array manager for the given part |
_part: string, _mgr: object
|
setArrayMgrs()
|
Sets all array manager objects - this function can be used to set the root array managers of the container object. |
_mgrs: object
|
setInstanceManager()
|
Set the instance manager Normally this is not needed as it’s set on the top-level container, and we just return that reference |
manager: etemplate2
|
submit()
|
Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission. |
_values:
|
validate()
|
Massively simplified validate, as compared to what ValidatorMixin gives us, since ValidatorMixin extends FormControlMixin which breaks SlSelect’s render() We take all validators for the widget, and if there’s a value (or field is required) we check the value with each validator. For array values we check each element with each validator. If the value does not pass the validator, we collect the message and display feedback to the user. We handle validation errors from the server with ManualMessages, which always “fail”. If the value is empty, we only validate if the field is required. |
skipManual:
|
_get_action_links()
|
Get all action-links / id’s of 1.-level actions from a given action object This can be overwritten to not allow all actions, by not returning them here. |
actions:
|
_handleClick()
|
Click handler calling custom handler set via onclick attribute to this.onclick |
_ev: MouseEvent
|
_labelTemplate()
|
Common sub-template to add a label. This goes inside the form control wrapper div, before and at the same depth as the input controls. | - |
_link_actions()
|
Link the actions to the DOM nodes / widget bits. |
actions: object
|
_oldChange()
|
Change handler calling custom handler set via onchange attribute |
_ev: Event
|
_set_label()
|
Do some fancy stuff on the label, splitting it up if there’s a %s in it Normally called from updated(), the “normal” setter stuff has already been run before this is called. We only override our special cases (%s) because the normal label has been set by the parent |
value: string
|
_setAriaAttributes()
|
Set aria-attributes on our input node | - |
destroy()
|
et2_widget compatability
true |
- |
set_class()
|
Set the widget class
Use this.class or this.classList instead |
new_class: string
|
set_disabled()
|
Wrapper on this.disabled because legacy had it.
Use widget.disabled for visually disabled, widget.hidden for visually hidden. Disabled vs Readonly vs Hidden |
value: boolean
|
set_statustext()
|
supports legacy set_statustext
use this.statustext |
value: string
|
Learn more about methods.
Parts
| Name | Description |
|---|---|
base |
Component internal wrapper |
button |
Button that opens browser’s file selection dialog |
list |
List of files |
Learn more about customizing CSS parts.