Light Dark System

Vfs Size

<et2-vfs-size> | Et2VfsSize

Human-readable file size. Extends Shoelace <sl-format-bytes> and unwraps the legacy row-bound value shape { size, mode, path } before passing the numeric size upstream.

When to use it

<et2-vfs-size> turns a byte count into something a person can read - 1.23 MB instead of 1234567. Use it anywhere a file size is shown: the filemanager’s size column, an attachment list, a quota display.

It is a pure formatter with no input of its own. Give it the number and it does the rest, in the user’s own locale - so the same widget prints 1.23 MB for one user and 1,23 MB for another.

Examples

What it does

bytes shown as
0
512
1536
1234567
5368709120 
<table>
    <thead>
        <tr><th align="left">bytes</th><th align="left">shown as</th></tr>
    </thead>
    <tbody>
        <tr><td>0</td><td><et2-vfs-size value="0"></et2-vfs-size></td></tr>
        <tr><td>512</td><td><et2-vfs-size value="512"></et2-vfs-size></td></tr>
        <tr><td>1536</td><td><et2-vfs-size value="1536"></et2-vfs-size></td></tr>
        <tr><td>1234567</td><td><et2-vfs-size value="1234567"></et2-vfs-size></td></tr>
        <tr><td>5368709120</td><td><et2-vfs-size value="5368709120"></et2-vfs-size></td></tr>
    </tbody>
</table>

How long the unit is spelled out

display chooses between short (the default, kB), long (kilobytes) and narrow (kB with no space). Long is worth it in a sentence; short is what you want in a table column.

· · 
<et2-vfs-size value="1234567" display="short"></et2-vfs-size> ·
<et2-vfs-size value="1234567" display="long"></et2-vfs-size> ·
<et2-vfs-size value="1234567" display="narrow"></et2-vfs-size>

Bytes or bits

unit switches between byte (the default) and bit. Bits are for transfer rates, not file sizes.

· 
<et2-vfs-size value="1536" unit="byte"></et2-vfs-size> ·
<et2-vfs-size value="1536" unit="bit"></et2-vfs-size>

In a row

The widget accepts the whole VFS row object as well as a bare number and picks size out of it, so binding it straight to the row works. 

<et2-vfs-size id="${row}[size]"/>

Nothing to show

A missing size renders nothing at all rather than 0 B, so a row with no size stays blank instead of claiming the file is empty. A real 0 still prints - an empty file is a fact worth showing.

zero: · no value: · (end of the line) 
zero: <et2-vfs-size value="0"></et2-vfs-size> ·
no value: <et2-vfs-size></et2-vfs-size> ·
(end of the line)

The same is true for null, undefined and non-numeric values assigned from javascript. Watch out for an empty-string attribute though: value="" in markup is converted to a number before the widget ever sees it, and so prints 0 byte rather than nothing.

From javascript

humanFileSize() is exported alongside the widget for the places that need a plain string rather than a rendered element - a “file too large, maximum %1” message, for instance. It uses binary prefixes (1 KB = 1024 B), which is what the server-side size limits are expressed in. 

import {humanFileSize} from "../../api/js/etemplate/Et2Vfs/Et2VfsSize";

humanFileSize(1536);    // "1.5 KB"
humanFileSize(1234567); // "1.2 MB"

Properties

Name Description Reflects Type Default
value
Row data from the VFS backend. Unlike Shoelace’s strict number type, this widget also accepts the legacy row object { size, mode, path } and unwraps .size before setting the underlying numeric value. - -

Learn more about attributes and properties.

Inherited properties (18)

Et2Widget

Name Description
accesskey Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character.
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.
align Used by Et2Box to determine alignment. Allowed values are left, right
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.
data Set the dataset from a CSV
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.
dom_id Get the actual DOM ID, which has been prefixed to make sure it’s unique.
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.
id Get the ID of the widget
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
noLang Disable any translations for the widget
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
statustext Tooltip which is shown for this element on hover
styles WebComponent *
options Get property-values as object
supportedWidgetClasses et2_widget compatability

LitElement

Name Description
updateComplete A read-only promise that resolves when the component has finished updating.
Inherited methods (21)

Et2Widget

Name Description
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.
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.
getArrayMgr() Returns the array manager object for the given part
getArrayMgrs() Returns an associative array containing the top-most array managers.
getChildren() Get child widgets Use .children to get web component children
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
loadingFinished() Needed for legacy compatability.
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.
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
setArrayMgr() Sets the array manager for the given part
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container 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
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick
destroy() et2_widget compatability
set_class() Set the widget class
set_disabled() Wrapper on this.disabled because legacy had it.
set_statustext() supports legacy set_statustext

Belongs to

Filemanager

These widgets are related by naming but not by inheritance or sub-widget composition.