Qt-Material

https://qt-material.readthedocs.io/en/latest/
Admin
A modern stylesheet library for PySide6 and PyQt6 inspired by Material Design, offering dark/light...
Tokens:4,241
Snippets:64
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Run Qt-Material examples

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Clones the repository, installs the library, navigates to the examples directory, and runs the main example application using PySide6.

```bash
git clone https://github.com/UN-GCPDS/qt-material.git
cd qt-material
python setup.py install
cd examples/full_features
python main.py --pyside6

```

--------------------------------

### Install Qt-Material from source

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Clone the repository and install the qt-material library from its source code.

```bash
git clone https://github.com/dunderlab/qt-material.git
cd qt-material
pip install .

```

--------------------------------

### Install Qt-Material using pip

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Install the latest version of the qt-material library using pip.

```bash
pip install -U qt-material

```

--------------------------------

### Example output of list_themes()

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

This is an example of the output produced by the list_themes() function, showing available theme filenames.

```text
['dark_amber.xml',
 'dark_blue.xml',
 'dark_cyan.xml',
 'dark_lightgreen.xml',
 'dark_pink.xml',
 'dark_purple.xml',
 'dark_red.xml',
 'dark_teal.xml',
 'dark_yellow.xml',
 'light_amber.xml',
 'light_blue.xml',
 'light_cyan.xml',
 'light_cyan_500.xml',
 'light_lightgreen.xml',
 'light_pink.xml',
 'light_purple.xml',
 'light_red.xml',
 'light_teal.xml',
 'light_yellow.xml']

```

--------------------------------

### Apply a dark teal theme to a PySide6 application

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Applies a built-in dark teal Material Design stylesheet to a PySide6 application. Ensure PySide6 is installed.

```python
import sys
from PySide6 import QtWidgets
from qt_material import apply_stylesheet

# Create application instance and main window
app = QtWidgets.QApplication(sys.argv)
window = QtWidgets.QMainWindow()

# Apply a built-in theme
apply_stylesheet(app, theme='dark_teal.xml')

# Show the window and execute
window.show()
app.exec()

```

--------------------------------

### Load Exported Theme in PySide6 Application

Source: https://qt-material.readthedocs.io/en/latest/notebooks/03-export.html

Loads a previously exported Qt-Material stylesheet (.qss) and registers an icon search path for use in a PySide6 application. This allows the application to use the custom theme without the qt-material package being installed at runtime.

```python
import sys
from PySide6 import QtWidgets
from PySide6.QtCore import QDir

app = QtWidgets.QApplication(sys.argv)

# Load stylesheet
with open('dark_teal.qss', 'r') as file:
    app.setStyleSheet(file.read())

# Register icon prefix
QDir.addSearchPath('icon', 'theme')

# Simple test window
window = QtWidgets.QMainWindow()
checkbox = QtWidgets.QCheckBox(window)
checkbox.setText('CheckBox')
window.show()
app.exec()
```

--------------------------------

### Define Custom Stylesheet Rules

Source: https://qt-material.readthedocs.io/en/latest/_sources/notebooks/01-customization.ipynb

Override or extend default Qt-Material styles using an external CSS file. This example defines styles for QPushButton and a custom class '.big_button'.

```css
QPushButton {
  color: {QTMATERIAL_SECONDARYCOLOR};
  text-transform: none;
  background-color: {QTMATERIAL_PRIMARYCOLOR};
}

.big_button {
  height: 64px;
}
```

--------------------------------

### Apply Theme at Startup

Source: https://qt-material.readthedocs.io/en/latest/notebooks/02-runtime.html

Inherit from `QtStyleTools` and use `apply_stylesheet()` to update the UI on the fly. This method can be used to apply a theme at startup.

```python
from qt_material import QtStyleTools, apply_stylesheet
from PySide6.QtWidgets import QMainWindow
from PySide6.QtUiTools import QUiLoader

class RuntimeStylesheets(QMainWindow, QtStyleTools):
    def __init__(self):
        super().__init__()
        self.main = QUiLoader().load('main_window.ui', self)

        # Apply a theme at startup
        self.apply_stylesheet(self.main, 'dark_teal.xml')

        # Other theme options
        # self.apply_stylesheet(self.main, 'light_red.xml')
        # self.apply_stylesheet(self.main, 'light_blue.xml')
```

--------------------------------

### List all available Qt-Material themes

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Prints a list of all available theme filenames that can be used with apply_stylesheet().

```python
from qt_material import list_themes

print(list_themes())

```

--------------------------------

### Create New Themes at Runtime

Source: https://qt-material.readthedocs.io/en/latest/notebooks/02-runtime.html

Call `show_dock_theme()` to enable a dock interface for customizing the current theme interactively. This generates and saves a new theme file as `my_theme.xml`.

```python
from qt_material import QtStyleTools
from PySide6.QtWidgets import QMainWindow
from PySide6.QtUiTools import QUiLoader

class RuntimeStylesheets(QMainWindow, QtStyleTools):
    def __init__(self):
        super().__init__()
        self.main = QUiLoader().load('main_window.ui', self)

        # Show the dock to create and export themes interactively
        self.show_dock_theme(self.main)
```

--------------------------------

### Apply a light purple theme

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Applies the 'light_purple.xml' theme to the Qt application.

```python
apply_stylesheet(app, theme='light_purple.xml')

```

--------------------------------

### Integrate Theme Selection Menu

Source: https://qt-material.readthedocs.io/en/latest/notebooks/02-runtime.html

Use `add_menu_theme()` to attach theme options to an existing `QMenu` object. This populates the menu with available themes and applies the selected one when clicked.

```python
from qt_material import QtStyleTools
from PySide6.QtWidgets import QMainWindow
from PySide6.QtUiTools import QUiLoader

class RuntimeStylesheets(QMainWindow, QtStyleTools):
    def __init__(self):
        super().__init__()
        self.main = QUiLoader().load('main_window.ui', self)

        # Connect the menuStyles QMenu to the dynamic theme switcher
        self.add_menu_theme(self.main, self.main.menuStyles)
```

--------------------------------

### Define Custom Theme Colors in XML

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Create a custom theme by defining color values in an XML file. Save this file and apply it using the apply_stylesheet function.

```xml
<!--?xml version="1.0" encoding="UTF-8"?-->
<resources>
<color name="primaryColor">#00e5ff</color>
<color name="primaryLightColor">#6effff</color>
<color name="secondaryColor">#f5f5f5</color>
<color name="secondaryLightColor">#ffffff</color>
<color name="secondaryDarkColor">#e6e6e6</color>
<color name="primaryTextColor">#000000</color>
<color name="secondaryTextColor">#000000</color>
</resources>
```

--------------------------------

### Apply a light theme with inverted secondary colors

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Applies the 'light_red.xml' theme and sets invert_secondary=True for better contrast on light backgrounds. This is recommended for light themes.

```python
from qt_material import apply_stylesheet

apply_stylesheet(app, theme='light_red.xml', invert_secondary=True)

```

--------------------------------

### Apply Custom Stylesheet from File

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Apply a custom CSS stylesheet to the application along with a theme file using the apply_stylesheet function.

```python
apply_stylesheet(app, theme='light_blue.xml', css_file='custom.css')
```

--------------------------------

### Export Qt-Material Theme to QSS and RCC

Source: https://qt-material.readthedocs.io/en/latest/notebooks/03-export.html

Exports a complete Qt-Material theme, including styles and resources, to .qss and .rcc files. This function requires the theme XML file, output paths for the stylesheet and resource archive, and an optional output directory for icons. Customization is possible via the 'extra' dictionary.

```python
from qt_material import export_theme

extra = {
    # Button colors
    'danger': '#dc3545',
    'warning': '#ffc107',
    'success': '#17a2b8',

    # Font
    'font_family': 'monoespace',
    'font_size': '13px',
    'line_height': '13px',

    # Density Scale
    'density_scale': '0',

    # Environment hints
    'pyside6': True,
    'linux': True,

}

export_theme(theme='dark_teal.xml',
             qss='dark_teal.qss',
             rcc='resources.rcc',
             output='theme',
             prefix='icon:/',
             invert_secondary=False,
             extra=extra,
            )
```

--------------------------------

### Apply a Custom Theme from Python

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Apply a custom theme defined in an XML file to the application using the apply_stylesheet function.

```python
apply_stylesheet(app, theme='dark_teal.xml')
```

--------------------------------

### Customize QMenu appearance

Source: https://qt-material.readthedocs.io/en/latest?badge=latest

Defines custom settings for QMenu to adjust height and padding, ensuring consistent appearance across different platforms and styles. This is independent of density scaling.

```python
extra = {
    'QMenu': {
        'height': 50,
        'padding': '10px 20px 10px 20px'  # top, right, bottom, left
    }
}


```

--------------------------------

### Define Custom Stylesheet in CSS

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Override or extend default Qt-Material styles using an external CSS file. Use Qt-Material color variables for dynamic theming.

```css
QPushButton {{
  color: {QTMATERIAL_SECONDARYCOLOR};
  text-transform: none;
  background-color: {QTMATERIAL_PRIMARYCOLOR};
}}

.big_button {{
  height: 64px;
}}
```

--------------------------------

### Customize QPushButton Styles and Fonts

Source: https://qt-material.readthedocs.io/en/latest/_sources/notebooks/01-customization.ipynb

Customize QPushButton appearance by defining custom colors and fonts in the 'extra' dictionary. Apply these customizations along with a theme.

```python
extra = {
    # Button colors
    'danger': '#dc3545',
    'warning': '#ffc107',
    'success': '#17a2b8',

    # Font
    'font_family': 'Roboto',
}

apply_stylesheet(app, 'light_cyan.xml', invert_secondary=True, extra=extra)
```

--------------------------------

### Apply Custom Stylesheet Dynamically at Runtime

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Append custom CSS content to the existing application stylesheet at runtime. This allows for dynamic styling updates.

```python
stylesheet = app.styleSheet()
with open('custom.css') as file:
    app.setStyleSheet(stylesheet + file.read().format(**os.environ))
```

--------------------------------

### Adjust UI Element Density Scale

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Control the spacing and sizing of UI elements by setting the 'density_scale' in the 'extra' argument. Negative values decrease density, positive values increase it.

```python
extra = {
    'density_scale': '-2',  # Lower density (more compact layout)
}

apply_stylesheet(app, 'default', invert_secondary=False, extra=extra)
```

--------------------------------

### Customize QPushButton Styles and Fonts

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Use the 'extra' argument in apply_stylesheet to define custom button colors and font families. These can then be applied to specific buttons.

```python
extra = {
    # Button colors
    'danger': '#dc3545',
    'warning': '#ffc107',
    'success': '#17a2b8',

    # Font
    'font_family': 'Roboto',
}

apply_stylesheet(app, 'light_cyan.xml', invert_secondary=True, extra=extra)
```

```python
pushButton_danger.setProperty('class', 'danger')
pushButton_warning.setProperty('class', 'warning')
pushButton_success.setProperty('class', 'success')
```

--------------------------------

### Apply Class-Based Style to a Widget

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Assign a custom class to a widget using setProperty('class', ...) to apply specific styles defined in the stylesheet.

```python
self.main.pushButton.setProperty('class', 'big_button')
```

--------------------------------

### Apply Class-Based Styles to Buttons

Source: https://qt-material.readthedocs.io/en/latest/_sources/notebooks/01-customization.ipynb

Apply specific styles to buttons by setting their 'class' property. This uses the styles defined in the stylesheet.

```python
pushButton_danger.setProperty('class', 'danger')
pushButton_warning.setProperty('class', 'warning')
pushButton_success.setProperty('class', 'success')
```

--------------------------------

### Remove Theme from a Single Widget

Source: https://qt-material.readthedocs.io/en/latest/notebooks/01-customization.html

Reset the stylesheet for a specific widget to an empty string to remove all inherited styling and revert to default appearance.

```python
widget.setStyleSheet('')
```
Tokens:
Raw