The modern theme for stable diffusion webui
Legacy verison a.k.a kitchen theme
English · [Russian ](./README-ru_RU.md)· [简体中文](./README-zh_CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
[![][github-release-shield]][github-release-link]
[![][discord-shield]][discord-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
![][cover]
> **Warning**\
> `Lobe Theme v3` is compatible with `SD WebUI v1.6` and is not backwards compatible. Versions below `< 1.6` should be moved to the branch [legacy-sd-webui-1.5](https://github.com/lobehub/sd-webui-lobe-theme/tree/legacy-sd-webui-1.5)
Table of contents
#### TOC
- [✨ Features](#-features)
- [📦 Installation](#-installation)
- [🤯 Usage](#-usage)
- [🖥 Environment Support](#-environment-support)
- [📦 Ecosystem](#-ecosystem)
- [⌨️ Local Development](#️-local-development)
- [🤝 Contributing](#-contributing)
- [🔗 Links](#-links)
- [More Products](#more-products)
- [Credits](#credits)
####
## ✨ Features
- [x] 🌗 Supports light and dark themes, with the ability to quickly switch in the navigation bar
- [x] 🌈 Supports custom theme colors and neutral colors, with the option to customize the logo
- [x] 🪄 Supports one-click formatting of the prompt, with a simple tag editor provided
- [x] 🎛️ Highly customizable sidebar, with a quick settings sidebar on the left and a model sidebar on the right
- [x] 🖼️ Adjustable canvas ratio, ensuring that generated images are always displayed at the top
- [x] 📱 Mobile-friendly, with partial optimization for mobile screens
- [x] 🌍Support i18n and welcome [PR](https://github.com/lobehub/sd-webui-lobe-theme/tree/main/locales) contributions
- [x] 📝 Syntax highlighting in the prompt input box
- [x] 📦 Support [PWA](https://support.google.com/chrome/answer/9658361) progressive web app
[![][back-to-top]](#readme-top)
## 📦 Installation
#### Method 1
Search for `Lobe Theme` or `Kitchen Theme` in the stable diffusion webui plugin market and install it.
> **Note**\
> **Version 2.0.0** was renamed to **Lobe Theme**
#### Method 2
As an extension (recommended), clone the repository to your extension folder:
```shell
git clone "https://github.com/lobehub/sd-webui-lobe-theme" extensions/lobe-theme
```
> **Important**\
> minimum requirements `gradio-3.41.2` & `sd-webui 1.6`
#### Upstream Sync
Star Us，You will receive all releases notifications from GitHub without any delay \~ ⭐️
Star History
[![][back-to-top]](#readme-top)
## 🤯 Usage
![][feat-thememode]
#### Light and Dark Themes
> **Note**\
> You can quickly switch between light and dark themes in the upper-right corner of the navigation bar.
The current theme supports both light and dark themes. If you want to force dark mode, use the `--theme=dark` argument to launch your WebUI. For example, on Windows, your `webui-user.bat` should include:
```shell
set COMMANDLINE_ARGS= --theme=dark
```
Alternatively, you can switch directly through URL Props:
```shell
http://localhost:7860/?__theme=light
http://localhost:7860/?__theme=dark
```
[![][back-to-top]](#readme-top)
![][feat-theme-modify]
#### Theme Customization
> **Note**\
> Click the `⚙` icon in the upper-right corner to open the settings panel. The current available settings are as follows:
- **Theme**
- Primary color: Currently offers `13` theme color combinations
- Neutral color: Currently offers `6` different grayscale color combinations
- Logo type: `Lobe`, `Kitchen`, `Custom`
- Custom logo: Supports `img url`, `base64`, and `emoji`. When a single emoji is entered, it will be automatically replaced with 3D Fluent Emoji.
- Custom title: Customize the site name.
[![][back-to-top]](#readme-top)
![][feat-highlight]
#### Prompt Syntax Highlighting
Automatically colorize prompt display according to the Stable Diffusion syntax rules
[![][back-to-top]](#readme-top)
![][feat-sidebar]
#### Sidebar Customization
> **Note**\
> Click the `⚙` icon in the upper-right corner to open the settings panel. The current available settings are as follows:
- **Prompt Textarea**
- Display mode: `scroll fixed height` | `resizable by text lines`
- **Sidebar**
- Default expand: `true`
- Display mode: `fixed` | `float`
- Default width: `280`
- **ExtraNetwork Sidebar**
- Enable: `true`
- Default expand: `true`
- Display mode: `fixed` | `float`
- Default width: `340`
- Default card size: `86`
Recommended System Settings
#### Extra-Networks
- thumbs
- width: 86
- height: 128
#### Quick-Setting
```txt
sd_model_checkpoint, sd_vae, CLIP_stop_at_last_layers, img2img_background_color, img2img_color_correction, samples_save, samples_format, grid_save, return_grid, n_rows, live_previews_enable, show_progress_every_n_steps, live_preview_refresh_period
```
[![][back-to-top]](#readme-top)
![][feat-mobile-friendly]
#### Mobile Adaptation
Partial convenience adaptation design has been completed for mobile devices, including breadcrumb foldable navigation bar, sidebar adaptation, etc. However, due to the high complexity and fixed values of the stable diffusion interface, it is difficult to ensure the same user experience as the desktop version. Feedback is welcome for more ideas.
[![][back-to-top]](#readme-top)
![][feat-pwa]
#### Progress Web App
You can use Progressive Web Apps [PWA](https://support.google.com/chrome/answer/9658361) for a fast stable diffusion experience on your computer or mobile device.
- On your computer, open Chrome.
- Go to stable diffusion website you want to install
- At the top right of the address bar, click `Install`
- Follow the onscreen instructions to install the PWA
[![][back-to-top]](#readme-top)
#### Prompt formatting
Click the 🪄 button below Prompt to format the prompt words with one click.
> **Note**\
> Convert full-width punctuation to half-width, remove extra spaces, add missing commas, and move the Extra-Networks model to the end.
Before formatting:
```text
photorealistic photo of a handsome male (wizard :1.2）， short beard, white wizard shirt, (with golden trim:0.8),
```
After formatting:
```text
photorealistic photo of a handsome male, (wizard:1.2), short beard, white wizard shirt, (with golden trim:0.8), ,
```
[![][back-to-top]](#readme-top)
## 🖥 Environment Support
| [](http://godban.github.io/browsers-support-badges/) Chrome | [](http://godban.github.io/browsers-support-badges/) Edge | [](http://godban.github.io/browsers-support-badges/) Safari |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| last 2 versions | last 2 versions | last 2 versions |
> **Warning**\
> There is currently a known compatibility issue with styles on Firefox browser.
[![][back-to-top]](#readme-top)
## 📦 Ecosystem
| NPM | Repository | Description | Version |
| ------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [@lobehub/ui][lobe-ui-link] | [lobehub/lobe-ui][lobe-ui-github] | Lobe UI is an open-source UI component library dedicated to building AIGC web applications. | [![][lobe-ui-shield]][lobe-ui-link] |
| [@lobehub/lint][lobe-lint-link] | [lobehub/lobe-lint][lobe-lint-github] | LobeLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub. | [![][lobe-lint-shield]][lobe-lint-link] |
| @lobehub/assets | [lobehub/assets][lobe-assets-github] | Logo assets, favicons, webfonts for LobeHub. | |
[![][back-to-top]](#readme-top)
## ⌨️ Local Development
You can use Github Codespaces for online development:
[![][codespaces-shield]][codespaces-link]
Alternatively, you can clone it for local development. To enable hot-reloading mode, you need to start stable diffuison on port `7860` in advance.
[![][bun-shield]][bun-link]
```bash
$ git clone https://github.com/lobehub/sd-webui-lobe-theme.git
$ cd sd-webui-lobe-theme
$ bun install
$ bun dev
```
[![][back-to-top]](#readme-top)
## 🤝 Contributing
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.
[![][pr-welcome-shield]][pr-welcome-link]
[![][contributors-contrib]][contributors-link]
[![][back-to-top]](#readme-top)
## 🔗 Links
### More Products
- **[🤖 Lobe Chat][lobe-chat] :** An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
- **[🌏 Lobe i18n][lobe-i18n] :** Lobe i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature.
- **[💌 Lobe Commit][lobe-commit] :** Lobe Commit is a CLI tool that leverages Langchain/ChatGPT to generate Gitmoji-based commit messages.
### Credits
- stable-diffusion-webui：
- gradio-theme-gallery:
- cozy-nest:
- _before `1.0.0` version_
- sd-web-ui-quickcs:
- Dark-Themes-SD-WebUI-Automatic1111:
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)