aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2019-09-30 14:48:26 +0200
committerNico Vertriest <nico.vertriest@qt.io>2019-10-07 13:36:26 +0000
commit8f543f69138edda91c60d7d55fbb70dc3982908e (patch)
tree4aa35cb838b0a6396cdc403f5392a06d8bacb6c8 /src/qml/doc
parentf4744a77224009cb46a254614106b9034a84fd4f (diff)
Doc: Add example on how to access types in imported QML from javascript
Task-number: QTBUG-66194 Change-Id: Ifd81db18a344557f610e45d7c2d4208f014e94b9 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/qml/doc')
-rw-r--r--src/qml/doc/src/javascript/imports.qdoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/qml/doc/src/javascript/imports.qdoc b/src/qml/doc/src/javascript/imports.qdoc
index 974f2e154f..8e26c4aadd 100644
--- a/src/qml/doc/src/javascript/imports.qdoc
+++ b/src/qml/doc/src/javascript/imports.qdoc
@@ -144,14 +144,17 @@ A JavaScript resource may import a QML module in the following fashion:
.import TypeNamespace MajorVersion.MinorVersion as Qualifier
\endcode
-For example:
+Below you can see an example that also shows how to use the QML types from a
+module imported in javascript:
+
\code
.import Qt.test 1.0 as JsQtTest
+
+var importedEnumValue = JsQtTest.MyQmlObject.EnumValue3
\endcode
In particular, this may be useful in order to access functionality provided
via a singleton type; see qmlRegisterSingletonType() for more information.
\note The .import syntax doesn't work for scripts used in the \l {WorkerScript}
-
*/