Skip to main content
Light Dark System

Vfs Select Dialog

<et2-vfs-select-dialog> | Et2VfsSelectDialog
Since 23.1

Open dialog // TODO: This doesn’t work because of Dialog / keymanager issues
<et2-vfs-select-dialog class="file-select"></et2-vfs-select-dialog>
<et2-button noSubmit>Open dialog</et2-button>
// TODO: This doesn't work because of Dialog / keymanager issues
<script>
  const dialog = document.querySelector('.file-select');
  const openButton = dialog.nextElementSibling;

  openButton.addEventListener('click', () => {dialog.show()});
</script>

Selected files

You can get the selected files by:

Widget value

If the dialog is in the template, it will return values on submit back to the server.

Change event

When the selected file(s) change, the change event is fired

const dialog = this.et2.getWidgetById("files");
dialog.addEventListener("change", this.handleFilesSelected);

getComplete() Promise

When the user closes the dialog, getComplete() will return the selected files.

const dialog = this.et2.getWidgetById("files");
let [button, files] = await dialog.getComplete();

This is probably the best way to get files (or directories) that you then want to do something with on the client. See also Et2VfsSelectButton which can pass the files to take action on the server.

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 -
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 -
buttonLabel Button label string "Select"
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 -
filename Provide a suggested filename for saving string ""
hasFeedbackFor
Get a list of feedback types string[] -
helpText
help-text
The select’s help text. If you need to display HTML, use the help-text slot instead. 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 -
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 -
mime Limit display to the given mime-type string | string[] | RegExp ""
mimeList List of mimetypes to allow user to filter. SelectOption[] [ { value: "/(application\/vnd.oasis.opendocument.text|application\/vnd.openxmlformats-officedocument.wordprocessingml.document)/i", label: "Documents" }, { value: "/(application\/vnd.oasis.opendocument.spreadsheet|application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet)/i", label: "Spreadsheets" }, {value: "image/", label: "Images"}, {value: "video/", label: "Videos"}, {value: "message/rfc822", label: "Email"} ]
mode Dialog mode Quickly sets button label, multiple, selection and for “select-dir”, mime-type "open" | "open-multiple" | "saveas" | "select-dir" -
multiple Allow selecting multiple files 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 -
path Start path in VFS. Leave unset to use the last used path. string ""
statustext Tooltip which is shown for this element on hover string -
styles
WebComponent * - -
title The dialog’s label as displayed in the header. You should always include a relevant label, as it is required for proper accessibility. string "Select"
translate
List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing. - -
value Currently selected files string[] []
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 EVENT NEEDS A DESCRIPTION Event

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:
dirname() Get directory of a path _path: string
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
fileInfo() Get file information of currently displayed paths Returns null if the path is not currently displayed _path:
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 .children to get web component children -
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 -
handleCreateDirectory() Create a new directory in the current one event: MouseEvent | KeyboardEvent
handleFileClick() SearchMixin handles the actual selection, we just reject directories here. event: MouseEvent
hide() Hides the dialog. -
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
searchResultSelected() This method must be called whenever the selection changes. It will update the selected file cache, the current value, and the display value -
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
show() Shows the dialog. -
submit() Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission. _values:
toggleResultSelection() Toggles a search result’s selected state result: HTMLElement & SearchResultElement, force: boolean
updated() A property has changed, and we want to make adjustments to other things based on that changedProperties: PropertyValues
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:
_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. -
_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
_setApiInstance() Inject application specific egw object with loaded translations into the dialog _egw_or_appname: string|egw
_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. Widgets that are hidden from the server via attribute or $readonlys will not be created. Widgets that are disabled from the server will not return a value to the application code.
value: boolean
set_statustext() supports legacy set_statustext
use this.statustext
value: string

Learn more about methods.