Skip to content

Commit 98bc6a4

Browse files
committed
Merge branch 'release/0.0.8' into main
2 parents bc0bc98 + 284afc7 commit 98bc6a4

7 files changed

Lines changed: 51 additions & 2 deletions

File tree

.DS_Store

-6 KB
Binary file not shown.
55 KB
Loading
56.6 KB
Loading

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
11
# ScreenNameViewer-For-Compose
2+
[![Hits](https://myhits.vercel.app/api/hit/https%3A%2F%2Fgithub.com%2FDongLab-DevTools%2FScreenNameViewer-For-Compose%3Ftab%3Dreadme-ov-file?color=blue&label=hits&size=small)](https://myhits.vercel.app)
3+
[![Platform](https://img.shields.io/badge/platform-Android-3DDC84?style=flat-square&logo=android)](https://developer.android.com)
4+
[![Min SDK](https://img.shields.io/badge/min%20sdk-21-green?style=flat-square)](https://developer.android.com)
5+
26

37
**[한국어 README](./README_ko.md)**
48

59
## Overview
610

711
![sample](https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/eae99cecc086002a6958e12620ec80647c89822f/.github/docs/images/screennameviewer-compose-exmaple.png)
812

13+
<a href="https://github.com/DongLab-DevTools/ScreenNameViewer">
14+
<img src="https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/9c53027addec40826ed428567965cfc46d17149f/.github/docs/images/screen_name_viewer_link_thumb_xml_en.png"/>
15+
</a>
16+
17+
<br>
18+
<br>
19+
920
ScreenNameViewer is a debugging tool that overlays the class name of the currently displayed screen.
1021
It allows you to intuitively check which screen is active, and in a Compose environment, it can also display the screen route.
1122

1223
This allows you to quickly find and navigate to the code for the desired screen, improving both debugging and development efficiency.
1324

25+
<br>
26+
1427
## Features
1528

1629
- **Real-time class name display**: Shows Activity and Fragment class names on screen in real-time
@@ -20,6 +33,8 @@ This allows you to quickly find and navigate to the code for the desired screen,
2033
- **Memory safe**: Prevents memory leaks using WeakReference
2134
- **Touch interaction**: Touch overlay to show full class name in toast
2235

36+
<br>
37+
2338
## Installation
2439

2540
### Step 1: Add GitHub Packages repository
@@ -65,9 +80,13 @@ github_token=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
6580
> [!NOTE]
6681
> You need a GitHub Personal Access Token with `read:packages` permission to download from GitHub Packages.
6782
83+
<br>
84+
6885
### Requirements
6986
- Android API 21 (Android 5.0) or higher
7087

88+
<br>
89+
7190
## Usage
7291

7392
### Initialize in Application class
@@ -117,6 +136,8 @@ class MyApplication : Application() {
117136
}
118137
```
119138

139+
<br>
140+
120141
## Configuration
121142

122143
### DSL Configuration
@@ -151,6 +172,8 @@ initScreenNameViewer(this) {
151172
}
152173
```
153174

175+
<br>
176+
154177
### Configuration Options
155178

156179
- **settings**: Configure activation conditions
@@ -162,6 +185,8 @@ initScreenNameViewer(this) {
162185
- `background`: Background color and padding
163186
- `position`: Margin and display positions for different components
164187

188+
<br>
189+
165190
## Contributors
166191

167192
<!-- readme: collaborators,contributors -start -->

README_ko.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# ScreenNameViewer-For-Compose
2-
![sample](https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/eae99cecc086002a6958e12620ec80647c89822f/.github/docs/images/screennameviewer-compose-exmaple.png)
32

43
## 개요
54

5+
![sample](https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/eae99cecc086002a6958e12620ec80647c89822f/.github/docs/images/screennameviewer-compose-exmaple.png)
6+
7+
<a href="https://github.com/DongLab-DevTools/ScreenNameViewer">
8+
<img src="https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/a1bedb1a1d026948f4b9b8cdf25e95293aab2cf1/.github/docs/images/screen_name_viewer_link_thumb_xml_kr.png"/>
9+
</a>
10+
11+
<br>
12+
<br>
13+
614
ScreenNameViewer는 현재 표시 중인 화면의 클래스명을 오버레이로 보여주는 디버깅 도구입니다.
715
어떤 화면이 활성화되어 있는지 직관적으로 확인할 수 있으며, Compose 환경에서는 Screen Route까지 함께 표시할 수 있습니다.
816

917
이를 통해 원하는 화면의 코드를 빠르게 찾아 접근할 수 있어 디버깅과 개발 효율을 높여줍니다.
1018

19+
<br>
20+
1121
## 특징
1222

1323
- **실시간 클래스명 표시**: Activity와 Fragment 클래스명을 화면에 실시간 표시
@@ -17,6 +27,8 @@ ScreenNameViewer는 현재 표시 중인 화면의 클래스명을 오버레이
1727
- **메모리 안전**: WeakReference 사용으로 메모리 누수 방지
1828
- **터치 상호작용**: 오버레이 터치 시 Toast로 전체 클래스명 표시
1929

30+
<br>
31+
2032
## 설치
2133

2234
### 1단계: GitHub Packages 저장소 추가
@@ -62,9 +74,13 @@ github_token=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
6274
> [!NOTE]
6375
> GitHub Packages에서 다운로드하려면 `read:packages` 권한이 있는 GitHub Personal Access Token이 필요합니다.
6476
77+
<br>
78+
6579
### 요구사항
6680
- Android API 21 (Android 5.0) 이상
6781

82+
<br>
83+
6884
## 사용법
6985

7086
### Application 클래스에서 초기화
@@ -114,6 +130,8 @@ class MyApplication : Application() {
114130
}
115131
```
116132

133+
<br>
134+
117135
## 설정
118136

119137
### DSL 설정
@@ -148,6 +166,8 @@ initScreenNameViewer(this) {
148166
}
149167
```
150168

169+
<br>
170+
151171
### 설정 옵션
152172

153173
- **settings**: 활성화 조건 설정
@@ -159,6 +179,8 @@ initScreenNameViewer(this) {
159179
- `background`: 배경색과 패딩
160180
- `position`: 여백과 각 컴포넌트의 표시 위치
161181

182+
<br>
183+
162184
## 기여자
163185

164186
<!-- readme: collaborators,contributors -start -->

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[versions]
2-
sdk_version = "0.0.7"
2+
sdk_version = "0.0.8"
33

44
agp = "8.1.4"
55
kotlin = "1.9.20"

screennameviewer/compose/src/main/java/com/donglab/screennameviewer/internal/viewer/ComponentNameViewerImpl.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ internal class ComponentNameViewerImpl(
4343

4444
private inner class ActivityLifecycleObserver : DefaultLifecycleObserver {
4545
override fun onCreate(owner: LifecycleOwner) {
46+
if (!settings.isEnabled) return
47+
4648
overlayRenderer.addActivityName(activity?.javaClass?.simpleName ?: "Unknown Activity")
4749
}
4850

0 commit comments

Comments
 (0)