Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 387a1bd

Browse files
committed
- readme update
1 parent ab13937 commit 387a1bd

File tree

1 file changed

+14
-211
lines changed

1 file changed

+14
-211
lines changed

README.md

Lines changed: 14 additions & 211 deletions
Original file line numberDiff line numberDiff line change
@@ -1,248 +1,51 @@
1+
<p align="center">
2+
<img loading="lazy" src="readme-resources/banner.png"/>
3+
</p>
4+
15
<h2 align="center">
26

3-
[![](https://img.shields.io/maven-central/v/io.github.yanndroid/oneui?label=maven%20central)](https://mvnrepository.com/artifact/io.github.yanndroid/oneui)
7+
[![](https://img.shields.io/maven-central/v/io.github.yanndroid/oneui?color=%23C71A36&label=Maven&logo=Apache%20Maven&logoColor=%23C11920&style=for-the-badge)](https://mvnrepository.com/artifact/io.github.yanndroid/oneui) [![](https://img.shields.io/badge/XDA-Thread-%23AC6E2F.svg?style=for-the-badge&logo=XDA-Developers)](https://forum.xda-developers.com/t/dev-library-5-0-oneui-design-library-2-2-1.4387485/) [![](https://img.shields.io/badge/Telegram-Yanndroid-blue.svg?style=for-the-badge&logo=Telegram)](https://t.me/Yanndroid)
48

59
</h2>
6-
<p align="center">
7-
<img loading="lazy" src="readme-resources/banner.png"/>
8-
</p>
910

10-
<img loading="lazy" src="https://github.com/Yanndroid/Yanndroid/blob/master/cats.gif" width="25" height="25" /> A library for Android, useful for creating Samsung's OneUI styled apps. This library contains a theme which will apply for most views (see [which](#Progress)) in your layout, and some custom OneUI views. The text which is in the custom views is translated to 90 languages, so you don't need to worry about these. Android 5.0 (api 21) and above are supported, the library also has Dark mode, Landscape, Tablet, DeX and RTL support. This library has been tested in Android Studio, but should work in other IDEs too. You can download and install the latest apk of the sample app [here](https://github.com/Yanndroid/OneUI-Design-Library/raw/master/app/release/app-release.apk). You can also check out my other apps for more examples on how to use this library. Suggestions, improvements and help are always welcome.
11+
<img loading="lazy" src="https://github.com/Yanndroid/Yanndroid/blob/master/cats.gif" width="25" height="25" /> A library for Android, useful for creating Samsung's OneUI **3 and 4** styled apps. This library contains a theme which will apply for most views in your layout, and a lot of additional custom OneUI views. The text which is in the custom views is translated to 90 languages, so you don't need to worry about these. Android 5.0 (api 21) and above are supported, the library also supports Dark mode, Landscape, Tablet, DeX and RTL. This library has been tested in Android Studio, but should work in other IDEs too. You can download and install the latest sample app apk [here](https://github.com/Yanndroid/OneUI-Design-Library/raw/master/app/release/app-release.apk) and also check out my other apps for some more examples on how to use this library. Suggestions, improvements and help are always welcome.
1112

1213
Huge thanks to [BlackMesa123](https://github.com/BlackMesa123) who has contributed a lot to this project.
1314

14-
15-
- [Screenshots](#Screenshots)
1615
- [Installation](#Installation)
17-
- [Issues](#Issues)
1816
- [Documentation](../../wiki)
19-
- [Changelog](#Changelog)
2017
- [More info](#More-info)
2118
- [Special thanks](#Special-thanks-to)
2219

23-
## Screenshots
24-
2520
<p align="center"><img loading="lazy" src="readme-resources/screenshots/screenshot_1.jpg" height="350"/> <img loading="lazy" src="readme-resources/screenshots/screenshot_2.jpg" height="350"/> <img loading="lazy" src="readme-resources/screenshots/screenshot_3.jpg" height="350"/> <img loading="lazy" src="readme-resources/screenshots/screenshot_4.jpg" height="350"/></p>
2621

2722
[GIF version](https://github.com/Yanndroid/OneUI-Design-Library/blob/master/readme-resources/screenshots/screenrecording.gif)
2823

2924
## Installation
3025

31-
1. Add the dependency to build.gradle (Module: ...)
26+
1. Add the dependency
3227
```gradle
33-
dependencies {
34-
implementation 'io.github.yanndroid:oneui:2.2.1'
35-
...
36-
}
28+
implementation 'io.github.yanndroid:oneui:2.2.1'
3729
```
3830
2. Apply the main theme in AndroidManifest.xml
3931
```xml
4032
<application
4133
...
42-
android:theme="@style/OneUITheme"
43-
>
34+
android:theme="@style/OneUITheme" >
4435
...
4536
</application>
4637
```
4738

48-
<details>
49-
<summary>If you're building apps specifically for Samsung devices, also check this out.</summary>
50-
51-
In order to enable even more UI elements, two flags can be used:
52-
- In AndroidManifest.xml, add the following flags inside the "application" tag:
53-
```xml
54-
<application
55-
...>
56-
<!-- enable Samsung UI elements -->
57-
<meta-data android:name="SamsungBasicInteraction" android:value="SEP10"/>
58-
<!-- disable icon squircle container -->
59-
<meta-data android:name="com.samsung.android.icon_container.has_icon_container" android:value="true"/>
60-
<!-- Samsung adaptive-icon (?) -->
61-
<meta-data android:name="com.samsung.android.icon_container.feature_appicon" android:value="ADAPTIVEICON_SHADOW"/>
62-
...
63-
</application>
64-
```
65-
- This one requires decompiling your app manually with [apktool](https://github.com/iBotPeaches/Apktool); replace manually the parent in ```Platform.V21.AppCompat``` and ```Platform.V25.AppCompat``` themes in the following files:
66-
```
67-
res/values/styles.xml
68-
res/values-v25/styles.xml
69-
```
70-
...with ```Theme.DeviceDefault.NoActionBar```.
71-
72-
</details>
73-
74-
## Issues
75-
76-
### Proguard
77-
78-
If you encounter problems with Proguard (missing classes), see this [Issue](https://github.com/Yanndroid/OneUI-Design-Library/issues/53) by [AlirezaIvaz](https://github.com/AlirezaIvaz).
79-
80-
### Preview render problem
81-
Some of the custom views might not render in the preview, because this library is using a font (```sec-roboto-light```), which Android Studio (and other IDEs probably too) don't know. To temporarily bypass this problem you can simply add
82-
```xml
83-
<string name="sesl_font_family_regular">sans-serif</string>
84-
```
85-
to your strings.xml. But don't forget to remove it afterwards for your release. Thanks to [roynatech2544](https://github.com/roynatech2544), for reporting this issue.
86-
87-
## Changelog
88-
89-
<details>
90-
<summary>2.2.1</summary>
91-
92-
- OneUI4++ (views, colors, fonts, themes)
93-
- PopupMenu improvements
94-
- fixes & minor changes
95-
96-
</details>
97-
98-
<details>
99-
<summary>2.2.0</summary>
100-
101-
- OneUI4++ (huge thanks to [BlackMesa123](https://github.com/BlackMesa123))
102-
- AppBar/Toolbar
103-
- Edge effect
104-
- TabLayout/BottomNavigationView
105-
- SwipeRefreshLayout
106-
- EditText
107-
- and more...
108-
- ToolbarLayout & PopupMenu/Menu improvements
109-
- icons++ (OneUI4)
110-
- fixes & minor changes
39+
3. Read the [Documentation](../../wiki)
11140

112-
</details>
113-
114-
<details>
115-
<summary>2.1.1</summary>
116-
117-
- ThemeColor > ThemeUtil
118-
- dark mode fix (ThemeUtil)
119-
- Button/AboutPage improvements
120-
- preference notifyChanged()
121-
- ToolbarLayout getToolbarMenuItemView()
122-
- OneUI4 Switch
123-
- minor changes
124-
125-
</details>
126-
127-
<details>
128-
<summary>2.1.0</summary>
129-
130-
- seekbar vertical and improved
131-
- toolbar improvements
132-
- SearchMode
133-
- SelectMode
134-
- custom Title & collapsed subtitle
135-
- toolbar menu
136-
- swipeRefreshLayout
137-
- PopupMenu improvements
138-
- some OneUI 4 stuff
139-
- crash fixes
140-
- icons++
141-
142-
</details>
143-
144-
<details>
145-
<summary>2.0.1</summary>
146-
147-
- fixed:
148-
- scroll behavior on clickable views
149-
- aboutpage button font and ripple
150-
- popupmenu going beyond screen
151-
- drawerLayout back click closes drawer
152-
- crash on small screens/dpi
153-
- icons++
154-
- Spinner
155-
- BottomNavigationView improvements
156-
157-
</details>
158-
159-
<details>
160-
<summary>2.0.0</summary>
161-
162-
- contributions from BlackMesa123:
163-
- AppBarLayout (& friends)
164-
- Preferences
165-
- Classic Color Picker
166-
- Dialogs
167-
- Tooltip
168-
- TabLayout
169-
- BottomNavigationView
170-
- Layouts rework
171-
- NestedScrollView, RecyclerView, Round Layouts
172-
- and much more (most of the stuff in this release)
173-
- a lot of fixes and improvements
174-
- support for api 21+
175-
- Snackbar & PopupMenu
176-
- more icons
177-
- now available on mavencentral
178-
179-
</details>
180-
181-
<details>
182-
<summary>1.3.0</summary>
183-
184-
- renamed library
185-
- getView methode added
186-
- splash screen display size fix
187-
- minor changes
188-
189-
</details>
190-
191-
<details>
192-
<summary>1.2.2</summary>
193-
194-
- Scrollbar
195-
- AboutPage
196-
- RelatedCard
197-
- corner fix
198-
- language update
199-
- customizable splash animation
200-
- expanded attribute for toolbar
201-
- fixed landscape toolbar height
202-
- improved orientation switching
203-
- button text fix
204-
- status & navigation bar dim on drawer slide
205-
- added changelog to readme
206-
207-
</details>
208-
209-
<details>
210-
<summary>1.2.1</summary>
211-
212-
- landscape support
213-
- tablet support
214-
- dex support
215-
- expandable attribute for toolbar
216-
- toolbar subtitle color
217-
- added Header style
218-
219-
</details>
220-
221-
<details>
222-
<summary>1.2.0</summary>
223-
224-
- colorPicker
225-
- color Changer
226-
- readme finished
227-
- much more icons
228-
- rtl support
229-
- translated to 90 languages
230-
231-
</details>
232-
233-
<details>
234-
<summary>1.1.3 - 1.0.0</summary>
235-
236-
- initial release/publish
237-
- most of the stuff (I don't remember anymore...)
238-
239-
</details>
240-
<br/>
41+
</br>
24142

24243
## More info
24344
- [Official OneUI Design Guide](https://design.samsung.com/global/contents/one-ui/download/oneui_design_guide_eng.pdf)
244-
- [Optimizing for DeX](https://developer.samsung.com/samsung-dex/modify-optimizing.html)
24545
- [Samsung's EULA](https://www.samsung.com/sg/Legal/SamsungLegal-EULA/)
46+
- [Optimizing for DeX](https://developer.samsung.com/samsung-dex/modify-optimizing.html)
47+
48+
</br>
24649

24750
## Special thanks to:
24851
- [Samsung](https://www.samsung.com/) for their awesome OneUI Design. :)

0 commit comments

Comments
 (0)