Importing QML Document Directories¶
Description of directory import statements in QML
A local directory of QML files can be imported without any additional setup or configuration. A remote directory of QML files can also be imported, but requires a directory listing
qmldir file to exist. A local directory may optionally contain a directory listing
Local Directory Imports¶
Any QML file on the local file system can import a local directory as using an import statement that refers to the directory’s absolute or relative file system path, enabling the file to use the object types defined within that directory.
If the local directory contains a directory listing
qmldir file, the types will be made available with the type names specified in the
qmldir file; otherwise, they will be made available with type names derived from the filenames of the QML documents. Only filenames beginning with an uppercase letter and ending with “.qml” will be exposed as types if no
qmldir file is specified in the directory.
Consider the following QML project directory structure. Under the top level directory
myapp, there are a set of common UI components in a sub-directory named
mycomponents, and the main application code in a sub-directory named
main, like this:
myapp |- mycomponents |- CheckBox.qml |- DialogBox.qml |- Slider.qml |- main |- application.qml
main/application.qml file can import the
mycomponents directory using the relative path to that directory, allowing it to use the QML object types defined within that directory:
The directory may be imported into a qualified local namespace, in which case uses of any types provided in the directory must be qualified:
The ability to import a local directory is convenient for cases such as in-application component sets and application prototyping, although any code that imports such modules must update their relevant
import statements if the module directory moves to another location. This can be avoided if QML modules are used instead, as an installed module is imported with a unique identifier string rather than a file system path.
Remotely Located Directories¶
A directory of QML files can also be imported from a remote location if the directory contains a directory listing
For example, if the
myapp directory in the previous example was hosted at “http://www.my-example-server.com”, and the
mycomponents directory contained a
qmldir file defined as follows:
CheckBox CheckBox.qml DialogBox DialogBox.qml Slider Slider.qml
Then, the directory could be imported using the URL to the remote
qmldir file located in the directory.
When importing directories from a remote server, developers should always be careful to only load directories from trusted sources to avoid loading malicious code.
Directory Listing qmldir Files¶
A directory listing
qmldir file distinctly different from a module definition qmldir file . A directory listing
qmldir file allows a group of QML documents to be quickly and easily shared, but it does not define a type namespace into which the QML object types defined by the documents are registered, nor does it support versioning of those QML object types.
The syntax of a directory listing
qmldir file is as follows:
Object Type Declaration
An object type declaration allows a QML document to be exposed with the given
Internal Object Type Declaration
internal <TypeName> <FileName>
An internal object type declaration allows a QML document to be registered as a type which becomes available only to the other QML documents contained in the directory import. The internal type will not be made available to clients who import the directory.
Example:internal HighlightedButton HighlightedBtn.qml
A local file system directory may optionally include a
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.