ve.File

ve.Component. ve.File

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

Basic file input that can also accept folders. Note that if you need a file explorer, you should refer to ve.FileExplorer, though this component uses its subtype.

  • Functional binding: veFile().
Constructor:
  • arg0_value: string - The current file path, if any.
  • arg1_options: Object
    • .do_not_display=false: boolean - Whether to display the file name to the left of the select file prompt
    • .is_folder=false: boolean - Whether the input is asking for a folder.
    • .multifile=false: boolean - Whether the input can accept multiple files/folders.
    • .save_function: function - If set, the current component will be a save prompt.
Instance:
  • .v: string
Methods:
  • openModal()

Constructor

new ve.File()

Source:

Extends

Members

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

Methods

openModal()

Opens the file explorer modal.

  • Method of: ve.File
Source:

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array

setValueFromObject(arg0_object, arg1_object)

Destructures Object values and transfers them into the .v instance fields of each Vercengen component.

Overrides:
Source:
Parameters:
Name Type Description
arg0_object Object

The Vercengen object to transfer to.
arg1_object Object

The other object to transfer from.