File Item
<et2-file-item> | Et2FileItem
Displays a single (uploaded) file with file information, upload status, etc.
<et2-file-item image="file-arrow-up">uploaded_file.ext</et2-file-item>
File items show files that have been or are being uploaded with a FileUpload
Examples
Closable
Add the closable attribute to show a close button that will hide the file.
<et2-file-item image="file-arrow-up" closable>uploaded_file.ext</et2-file-item>
File size
Set the size attribute in bytes to display the file’s size.
<et2-file-item image="file-arrow-up" size="123455678" >uploaded_file.ext</et2-file-item>
Loading & Progress
Set the loading attribute to indicate action on the file. Set progress to show
progress.
<et2-file-item image="file-arrow-up" loading>uploaded_file.ext</et2-file-item>
<et2-file-item image="file-arrow-up" loading progress="35">uploaded_file.ext</et2-file-item>
Variants
Use the variant attribute to set the file item’s variant.
<et2-file-item image="file-arrow-up" variant="default">Default</et2-file-item>
<et2-file-item image="file-arrow-up" variant="primary">Primary</et2-file-item>
<et2-file-item image="file-arrow-up" variant="success">Success</et2-file-item>
<et2-file-item image="file-arrow-up" variant="neutral">Neutral</et2-file-item>
<et2-file-item image="file-arrow-up" variant="warning">Warning</et2-file-item>
<et2-file-item image="file-arrow-up" variant="danger">Danger</et2-file-item>
Warnings and errors
variant combined with an appropriate image can be used to show a status message.
<et2-file-item image="file-earmark-check" variant="success">File uploaded successfully</et2-file-item>
<et2-file-item image="exclamation-triangle" variant="warning">Upload interrupted. Please try again later.</et2-file-item>
<et2-file-item image="exclamation-octagon" variant="danger">Wrong filetype</et2-file-item>Slots
| Name | Description |
|---|---|
| (default) | File name |
image
|
The file’s image (mimetype icon, status icon, etc) |
close-button
|
Close button |
Learn more about using slots.
Properties
| Name | Description | Reflects | Type | Default |
|---|---|---|---|---|
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
|
- |
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
|
- |
closable
|
Makes the item closable (removable). |
|
boolean
|
false
|
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
|
display
|
Different ways of displaying the item. Large for a few files, small is like a tag, list is for several files |
|
"large" | "small" | "list"
|
"large"
|
dom_id
|
Get the actual DOM ID, which has been prefixed to make sure it’s unique. |
string
|
- | |
hidden
|
Indicates whether the file item is hidden. |
|
boolean
|
false
|
id
|
Get the ID of the widget |
string
|
- | |
image
|
The file’s thumbnail image |
string
|
""
|
|
label
|
The label of the widget This is usually displayed in some way. It’s also important for accessability. This is defined in the parent somewhere, and re-defining it causes labels to disappear |
string
|
- | |
loading
|
Draws the item in a loading state. |
|
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
|
- | |
progress
|
The current progress, 0 to 100. Only used if loading property is true. |
|
number
|
- |
size
|
The size of the file in bytes as a read-only 64-bit integer. |
|
number
|
- |
statustext
|
Tooltip which is shown for this element on hover |
|
string
|
- |
styles
|
WebComponent * | - | - | |
value
|
A unique value to store in the item. This can be used as a way to identify items. |
string
|
""
|
|
variant
|
The item’s theme variant. |
|
"default" | "primary" | "success" | "neutral" | "warning" | "danger"
|
"default"
|
options
|
Get property-values as object
use widget methods |
object
|
- | |
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 |
|---|---|---|---|
load |
Emitted when file is loaded | - |
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:
|
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 |
- |
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 | - |
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
|
_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
|
_link_actions()
|
Link the actions to the DOM nodes / widget bits. |
actions: object
|
_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
|
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 |
Learn more about customizing CSS parts.