Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove mention to IIconRegistry from the docs #7886

Merged
merged 1 commit into from Feb 24, 2020
Merged

Remove mention to IIconRegistry from the docs #7886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/source/developer/ui_helpers.rst
View file
Open in desktop
Expand Up @@ -69,15 +69,14 @@ a ``Promise`` resolving in a ``Dialog.IResult`` object.
File Dialogs
''''''''''''

Two helper functions to ask a user to open a file or a directory are
Two helper functions to ask a user to open a file or a directory are
available in the ``filebrowser`` package under the namespace ``FileDialog``.

Here is an example to request a file.

.. code:: typescript

const dialog = FileDialog.getOpenFiles({
iconRegistry, // IIconRegistry
manager, // IDocumentManager
filter: model => model.type == 'notebook' // optional (model: Contents.IModel) => boolean
});
Expand All @@ -93,7 +92,6 @@ And for a folder.
.. code:: typescript

const dialog = FileDialog.getExistingDirectory({
iconRegistry, // IIconRegistry
manager // IDocumentManager
});

Expand All @@ -103,7 +101,6 @@ And for a folder.
let folders = result.value;
}

.. note:: The document manager and the icon registry can be obtained in a plugin by
requesting ``IFileBrowserFactory`` token. The ``manager`` will be accessed through
``factory.defaultBrowser.model.manager`` and the ``iconRegistry`` through
``factory.defaultBrowser.model.iconRegistry``.
.. note:: The document manager can be obtained in a plugin by
requesting ``IFileBrowserFactory`` token. The ``manager`` will be accessed through
``factory.defaultBrowser.model.manager``.