.. _pyside-api:

Modules API
===========

Basic modules
-------------

These are the main modules that help you build a Widget-based UI.

.. grid:: 1 3 4 4
    :gutter: 2

    .. grid-item-card:: :mod:`Qt Core <PySide6.QtCore>`

        Core non-graphical classes used by other modules.

    .. grid-item-card:: :mod:`Qt GUI <PySide6.QtGui>`

        Base classes for graphical user interface (GUI) components.

    .. grid-item-card:: :mod:`Qt Widgets <PySide6.QtWidgets>`

        Classes to extend Qt GUI with Python widgets.

QML and Qt Quick
----------------

Use these modules to interact with the `QML Language <https://doc.qt.io/qt-6/qmlapplications.html>`_,
from Python.

.. grid:: 1 3 4 4
    :gutter: 2

    .. grid-item-card:: :mod:`Qt Qml <PySide6.QtQml>`

        Classes for QML and JavaScript languages.

    .. grid-item-card:: :mod:`Qt Quick <PySide6.QtQuick>`

        A declarative framework for building highly dynamic applications
        with custom UIs.

    .. grid-item-card:: :mod:`Qt Quick Controls <PySide6.QtQuickControls2>`

        Lightweight QML types for creating performant user interfaces for
        desktop, embedded, and mobile devices.

    .. grid-item-card:: :mod:`Qt Quick Widgets <PySide6.QtQuickWidgets>`

        Provides a Python widget class for displaying a Qt Quick user interface.

All the modules
---------------

There are many other modules currently supported by |pymodname|, here you can find a complete list
of them.

.. toctree::

   modules.rst