blob: f56b087b359d4ffd405b415b28d01fb8115a0897 [file] [log] [blame] [view]
Theresa Wellingtonb0767a72019-10-01 00:17:461# Chrome for Android UI
2
3## Ramping-up
4
5Android has a number of [developer guides](https://developer.android.com/guide) that are helpful for getting ramped up on general Android development. We recommend reading the following as primers for developing UI:
6
7 * [Application fundamentals](https://developer.android.com/guide/components/fundamentals)
8 * [Providing resources](https://developer.android.com/guide/topics/resources/providing-resources.html)
9 * [Layouts](https://developer.android.com/guide/topics/ui/declaring-layout)
10 * [Introduction to activities](https://developer.android.com/guide/components/activities/intro-activities)
11
12
13## Colors and text styles
14
Sinan Sahin82650502022-04-07 18:00:2115[Dynamic Color doc](dynamic_colors.md) should be followed when working on UI. For colors that cannot/should not be made dynamic (as mentioned in the doc), Chrome for Android has a color palette defined in [//ui/android/java/res/values/color_palette.xml](/ui/android/java/res/values/color_palette.xml) and a set of reusable semantic colors defined in [//ui/android/java/res/values/semantic_colors_adaptive.xml](/ui/android/java/res/values/semantic_colors_adaptive.xml). The semantic colors from semantic_colors_adaptive.xml should be used to ensure colors adapt properly for dark mode and can be consistently and easily updated during product-wide visual refreshes.
Theresa Wellingtonb0767a72019-10-01 00:17:4616
17For more information on selecting the right color, see [Night Mode on Chrome Android](night_mode.md).
18
Sinan Sahin82650502022-04-07 18:00:2119Text should be styled with a pre-defined text appearance from [//components/browser_ui/styles/android/java/res/values/styles.xml](/components/browser_ui/styles/android/java/res/values/styles.xml). If the text color cannot/should not be dynamic, pre-defined text styles from [//ui/android/java/res/values-v17/styles.xml](/ui/android/java/res/values-v17/styles.xml) can be used. If leading (aka line height) is needed, use [org.chromium.ui.widget.TextViewWithLeading](/ui/android/java/src/org/chromium/ui/widget/TextViewWithLeading.java) with `app:leading` set to one of the pre-defined *_leading dimensions in [//ui/android/java/res/values/dimens.xml](/ui/android/java/res/values/dimens.xml).
Theresa Wellingtonabc3e5c2019-10-01 16:55:5520
Theresa Wellingtonb0767a72019-10-01 00:17:4621## Widgets
22
23The Chromium code base contains a number of wrappers around Android classes (to smooth over bugs or save on binary size) and many UI widgets that provide Chrome-specific behavior and/or styling.
24
Theresa Wellington95cc3b42020-01-25 21:25:0525These can be found in [//components/browser_ui/widget/android/](/components/browser_ui/widget/android/), [//ui/android/](/ui/android/), and [//chrome/android/java/src/org/chromium/chrome/browser/widget/](/chrome/android/java/src/org/chromium/chrome/browser/widget/). There is an ongoing effort to consolidate all widgets in //components/browser_ui/widget/android.
Theresa Wellingtonb0767a72019-10-01 00:17:4626
27## MVC
28
29UI development should follow a modified Model-View-Controller pattern. MVC base classes live in [//ui/android/java/src/org/chromium/ui/modelutil](/ui/android/java/src/org/chromium/ui/modelutil/).
30
31The following guides introduce MVC in Chrome for Android:
32
33 * [So, you want to do MVC...](mvc_architecture_tutorial.md)
34 * [Simple Lists in MVC Land](mvc_simple_list_tutorial.md)
35 * [Simple RecyclerView use in MVC](mvc_simple_recycler_view_tutorial.md)
36 * [So, you want to test MVC...](mvc_testing.md)