File input
==========

Overview
--------

:code:`FileInput` is a field widget to search for files in the SEPAL folders. it inherits from the :code:`SepalWidget` class.
Any argument from the original :code:`Layout` ipyvuetify class can be used to complement it.

.. jupyter-execute::
    :raises:
    :stderr:

    from pysepal import sepalwidgets as sw

    # correct colors for the documentation
    # set to dark in SEPAL by default
    import ipyvuetify as v
    v.theme.dark = False

    file_input = sw.FileInput()
    file_input

the value can be retrieve from the :code:`v_model` trait.

Methods
-------

select_file
^^^^^^^^^^^

Manually select a file from it's path. No verification on the extension is performed.

.. jupyter-execute::
    :raises:
    :stderr:

    from pysepal import sepalwidgets as sw
    from pathlib import Path

    # correct colors for the documentation
    # set to dark in SEPAL by default
    import ipyvuetify as v
    v.theme.dark = False

    path = Path.home()/'test.txt'
    path.write_text("hello world")

    file_input = sw.FileInput()
    file_input.select_file(path)
    file_input

reset
^^^^^


Clear the File selection and move to the root folder if something was selected.

.. jupyter-execute::
    :raises:
    :stderr:

    from pysepal import sepalwidgets as sw
    from pathlib import Path

    # correct colors for the documentation
    # set to dark in SEPAL by default
    import ipyvuetify as v
    v.theme.dark = False

    path = Path.home()/'test.txt'
    path.write_text("hello world")

    file_input = sw.FileInput()
    file_input.select_file(path)
    file_input.reset()
    file_input

.. note::

    More information can be found `here <../modules/pysepal.sepalwidgets.html#pysepal.sepalwidgets.inputs.FileInput>`__.