Skip to content

Commit a3050b2

Browse files
committed
UPDATE: Example to English
1 parent f534151 commit a3050b2

File tree

3 files changed

+37
-17
lines changed

3 files changed

+37
-17
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,50 @@
44
![Platforms](https://img.shields.io/badge/Platforms-macOS_iOS-yellowgreen?style=flat-square)
55
![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
66

7-
OpenTDS is Toss Design System Clone for SwiftUI
7+
OpenTDS is Toss Design System Clone for SwiftUI.
88

99
## Requirements
1010
| Platform | Minimum Swift Version | Installation |
1111
| --- | --- | --- |
1212
| iOS 14.0+ / macOS 10.11+ | 5.5 | [Swift Package Manager](#swift-package-manager) |
1313

14+
## Disclaimer
15+
This package is unfinished and not ready for deployment.
16+
1417
## Installation
1518
### Swift Package Manager
16-
17-
Add it to the `dependencies` value of your `Package.swift`.
19+
- `File` -> `Add Packages...` And paste the repository URL.
20+
- Or add it to the `dependencies` value of your `Package.swift`.
1821
```swift
1922
dependencies: [
2023
.package(url: "https://github.com/Mercen-Lee/OpenTDS.git", .branch("main"))
2124
]
2225
```
2326

2427
## Components
28+
- [TossTabView](#tosstabview)
29+
- [TossTabViewButton](#tosstabviewbutton)
30+
31+
## Examples
2532
### TossTabView
33+
> Animated Tab View of Toss.
34+
- The number of Views must be between 2 and 5.
35+
- Every single View should have `.tossTabItem` Modifier.
2636
```swift
2737
TossTabView {
2838
HomeView()
29-
.tossTabItem("", Image(systemName: "house.fill"))
39+
.tossTabItem("Home", Image(systemName: "house.fill"))
3040
MyView()
31-
.tossTabItem("마이", Image(systemName: "person.fill"))
41+
.tossTabItem("My", Image(systemName: "person.fill"))
42+
}
43+
```
44+
45+
### TossTabViewButton
46+
> Animated Tab View Button of Toss.
47+
- It exists for TossTabView.
48+
```swift
49+
TossTabViewButton("Home", Image(systemName: "house.fill"), true) {
50+
anyMethod()
3251
}
3352
```
3453

Sources/OpenTDS/Component/TabView/TabView+Button.swift

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
import SwiftUI
22

33
/**
4-
Toss 탭뷰의 버튼입니다.
4+
Animated Tab View Button of Toss.
5+
It exists for TossTabView..
56

6-
TossTabViewButton("", Image(systemName: "house.fill"), idx == selected) {
7+
TossTabViewButton("Home", Image(systemName: "house.fill"), idx == selected) {
78
anyMethod()
89
}
910
*/
@@ -20,13 +21,11 @@ public struct TossTabViewButton: View {
2021
@State var rectangleState: Bool = false
2122

2223
/**
23-
탭뷰 버튼을 반환합니다.
24-
2524
- Parameters:
26-
- label: 버튼 레이블입니다.
27-
- image: 버튼 이미지입니다.
28-
- selected: 버튼 하이라이트 여부입니다.
29-
- action: 버튼을 눌렀을 때 실행할 액션입니다.
25+
- label: Label of the Button.
26+
- image: Image of the Button.
27+
- selected: Highlight status of the Button.
28+
- action: Action when the Button pressed.
3029
*/
3130
public init(_ label: String,
3231
_ image: Image,

Sources/OpenTDS/Component/TabView/TabView.swift

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
import SwiftUI
22

33
/**
4-
Toss의 탭뷰입니다.
5-
2~5개의 View를 사용할 수 있습니다. tossTabItem Modifier는 필수입니다.
4+
Animated Tab View of Toss.
5+
6+
The number of Views must be between 2 and 5.
7+
Every single View should have `.tossTabItem` Modifier.
68

79
TossTabView {
810
HomeView()
9-
.tossTabItem("", Image(systemName: "house.fill"))
11+
.tossTabItem("Home", Image(systemName: "house.fill"))
1012
MyView()
11-
.tossTabItem("마이", Image(systemName: "person.fill"))
13+
.tossTabItem("My", Image(systemName: "person.fill"))
1214
}
1315
*/
1416
@available(macOS 11, iOS 14, *)

0 commit comments

Comments
 (0)