Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 6ebf55c

Browse files
hharkovenkoashvayka
authored andcommitted
split app icon and splash screen into 2 documents, for pre 1.7 and 1.7x app version
1 parent 23c2c9c commit 6ebf55c

4 files changed

Lines changed: 82 additions & 57 deletions

File tree

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{% if docsPrefix == 'pe/' %}
2+
{% assign peDocsPrefix = "pe/" %}
3+
{% else %}
4+
{% assign peDocsPrefix = "" %}
5+
{% endif %}
6+
* TOC
7+
{:toc}
8+
9+
### Splash Screen
10+
11+
You cannot change the splash screen in pre-1.7.0 versions. It will default to your app's icon.
12+
13+
### App Icon
14+
15+
The Flutter app comes with a default launcher icon. To change it with your custom one, follow these instructions:
16+
17+
#### Step 1: Add flutter_launcher_icons Plugin
18+
19+
Add the flutter_launcher_icons plugin to your project via command line:
20+
21+
```bash
22+
flutter pub add dev:flutter_launcher_icons
23+
```
24+
{: .copy-code}
25+
#### Step 2: Replace Default Icon
26+
27+
Replace `thingsboard.png` in the `assets/images` folder with your custom icon. We recommend using a 432×432 pixel image of your logo centered within the canvas.
28+
29+
#### Step 3: Run the Generator
30+
31+
Execute the generator to apply your new icon:
32+
33+
```bash
34+
flutter pub run flutter_launcher_icons
35+
```
36+
{: .copy-code}
37+
38+
#### Step 4: Update Notification Icon (Optional)
39+
40+
If you have configured push notifications (see [push notifications setup guide](/docs/pe/mobile/getting-started/#step-2-optional-configure-push-notifications)), we recommend updating the notification icon as well.
41+
42+
1. Go to [Android Asset Studio](https://romannurik.github.io/AndroidAssetStudio/icons-notification.html)
43+
2. Press "Image" and choose your logo
44+
3. Configure padding if needed
45+
4. Change the file name to "thingsboard"
46+
5. Press the download button to get an archive of the "res" folder
47+
6. Paste the contents to `android/app/src/main` and click "Replace" when prompted
48+
49+
<div style="display: flex; flex-direction: row;">
50+
<div style="display: flex; flex-direction: column; align-items: center;">
51+
<img width="" src="/images/mobile/asset_studio.png" title="Android asset studio flow" alt="Android asset studio flow">
52+
</div>
53+
</div>
54+
55+
{% capture pre_version_note %}
56+
**Note:** Pre-1.7.0 versions have limited customization options compared to newer versions. Consider upgrading to version 1.7.0+ for full branding capabilities.
57+
{% endcapture %}
58+
{% include templates/info-banner.md content=pre_version_note %}

_includes/docs/mobile/app-icon-splash-screen.md

Lines changed: 10 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
{% if docsPrefix == 'pe/' %}
2+
{% assign peDocsPrefix = "pe/" %}
3+
{% else %}
4+
{% assign peDocsPrefix = "" %}
5+
{% endif %}
16
* TOC
27
{:toc}
38

@@ -7,10 +12,13 @@ An **app icon** is the visual representation of your application that appears on
712

813
A **splash screen** is the initial screen displayed when an application is launched, typically showing a logo or branding while the app loads.
914

10-
## App version 1.7.0+
11-
1215
For app version 1.7.0 and above, you need several assets to fully customize your app. You will find default examples of the required assets in the `assets/branding` folder.
1316

17+
{% capture pre_1_7_0_link %}
18+
Important Notice: Please use [this guide](/docs/{{peDocsPrefix}}mobile/app-icon-splash-screen-before-v1.7/) for pre 1.7.x configuration
19+
{% endcapture %} {% include templates/info-banner.md content=pre_1_7_0_link %}
20+
21+
1422
### Required Assets
1523

1624
The following assets are required for complete customization:
@@ -143,58 +151,3 @@ dart run flutter_launcher_icons
143151
dart run flutter_native_splash:create
144152
```
145153
{: .copy-code}
146-
147-
## App version pre 1.7.0
148-
149-
For app versions prior to 1.7.0, the customization process is different and more limited.
150-
151-
### Splash Screen
152-
153-
You cannot change the splash screen in pre-1.7.0 versions. It will default to your app's icon.
154-
155-
### App Icon
156-
157-
The Flutter app comes with a default launcher icon. To change it with your custom one, follow these instructions:
158-
159-
#### Step 1: Add flutter_launcher_icons Plugin
160-
161-
Add the flutter_launcher_icons plugin to your project via command line:
162-
163-
```bash
164-
flutter pub add dev:flutter_launcher_icons
165-
```
166-
{: .copy-code}
167-
#### Step 2: Replace Default Icon
168-
169-
Replace `thingsboard.png` in the `assets/images` folder with your custom icon. We recommend using a 432×432 pixel image of your logo centered within the canvas.
170-
171-
#### Step 3: Run the Generator
172-
173-
Execute the generator to apply your new icon:
174-
175-
```bash
176-
flutter pub run flutter_launcher_icons
177-
```
178-
{: .copy-code}
179-
180-
#### Step 4: Update Notification Icon (Optional)
181-
182-
If you have configured push notifications (see [push notifications setup guide](/docs/pe/mobile/getting-started/#step-2-optional-configure-push-notifications)), we recommend updating the notification icon as well.
183-
184-
1. Go to [Android Asset Studio](https://romannurik.github.io/AndroidAssetStudio/icons-notification.html)
185-
2. Press "Image" and choose your logo
186-
3. Configure padding if needed
187-
4. Change the file name to "thingsboard"
188-
5. Press the download button to get an archive of the "res" folder
189-
6. Paste the contents to `android/app/src/main` and click "Replace" when prompted
190-
191-
<div style="display: flex; flex-direction: row;">
192-
<div style="display: flex; flex-direction: column; align-items: center;">
193-
<img width="" src="/images/mobile/asset_studio.png" title="Android asset studio flow" alt="Android asset studio flow">
194-
</div>
195-
</div>
196-
197-
{% capture pre_version_note %}
198-
**Note:** Pre-1.7.0 versions have limited customization options compared to newer versions. Consider upgrading to version 1.7.0+ for full branding capabilities.
199-
{% endcapture %}
200-
{% include templates/info-banner.md content=pre_version_note %}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: docwithnav-mobile
3+
title: Configure app icon and splash screen in ThingsBoard Mobile Application
4+
5+
---
6+
7+
{% include docs/mobile/app-icon-splash-screen-before-v1.7.md %}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: docwithnav-mobile-pe
3+
title: Configure app icon and splash screen in ThingsBoard Mobile Application
4+
5+
---
6+
{% assign docsPrefix = "pe/" %}
7+
{% include docs/mobile/app-icon-splash-screen-before-v1.7.md %}

0 commit comments

Comments
 (0)