Get started
The Common UI module is a core configuration module for all DriveKit UI modules.
To add Common UI module to your app, add the following line to your dependencies in your application build.gradle file:
build.gradle
dependencies {
implementation 'com.drivequant.drivekit:drivekit-common-ui:$drivekitui_version'
}
Replace
$drivekitui_version with the DriveKit version you are using in your appAn initialization phase is required to ensure that Common UI module works perfectly. To initialize Common UI module in your app, you must call the initialization method in
onCreate method of your application class.Kotlin
Java
class MyApplication: Application() {
override fun onCreate() {
super.onCreate()
DriveKitUI.initialize()
}
}
public class DriveQuantApplication {
@Override
public void onCreate() {
super.onCreate();
DriveKitUI.INSTANCE.initialize();
}}
This method will initialize the SDK with the default configuration set up by DriveQuant.
The colors that can be configured are listed in the table below:
Name | Description | Default value |
primaryColor | Main app color | #083B54 |
secondaryColor | Call to action color | #77E2B0 |
mainFontColor | Main font color | #161616 |
complementaryFontColor | Secondary font color | #9E9E9E |
fontColorOnPrimaryColor | Color of a text displayed on an element whose color is primaryColor | #FFFFFF |
fontColorOnSecondaryColor | Color of a text displayed on an element whose color is secondaryColor | #FFFFFF |
backgroundViewColor | Background color | #FAFAFA |
neutralColor | Color of the separating lines | #F0F0F0 |
warningColor | Warning color (non-critical hint) | #F7A334 |
criticalColor | Alert color (critical hint) | #E52027 |
To override the default colors configuration you just have to create a reference of DKColors and override the color that you want to change. Then pass it as a parameter to the initialize method.
Kotlin
Java
class ColorsConfig : DKColors() {
override fun primaryColor(): Int = Color.GREEN
override fun secondaryColor(): Int = Color.RED
}
class ColorsConfig extends DKColors {
@Override
public int primaryColor() {
return Color.GREEN;
}
@Override
public int secondaryColor() {
return Color.RED;
}
}
Kotlin
Java
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
val colorsConfig = ColorsConfig()
DriveKitUI.initialize(colors = colorsConfig)
}
}
public class DriveQuantApplication {
@Override
public void onCreate() {
super.onCreate();
ColorsConfig colorConfig = new ColorsConfig();
DriveKitUI.INSTANCE.initialize(colorsConfig);
...
}}
The Common UI configuration module allows to set up two fonts:
- 1.
primaryFont: this is the main font used in the application. The default value is Roboto. - 2.
secondaryFont: this the font used on the page titles or to emphasize a specific point. The default value is Roboto.
To override the font, you can add the primary and secondary fonts to the CommonUI module by calling the following method:
Kotlin
Java
class FontConfig : DKFonts() {
override fun primaryFont(): Int = R.font.sketchy
}
class FontsConfig extends DKFonts {
@Override
public int primaryFont() {
return R.font.sketchy;
}
}
Kotlin
Java
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
val fontsConfig = FontsConfig()
DriveKitUI.initialize(fonts = fontsConfig)
}
}
public class DriveQuantApplication {
@Override
public void onCreate() {
super.onCreate();
FontsConfig fontsConfig = new FontsConfig();
DriveKitUI.INSTANCE.initialize(fontsConfig);
...
}}
Contents of each DriveKit UI module are translated into 5 languages: English, French, German, Spanish and Italian.
DriveKit simplifies the internationalization of your application and it is possible to add other languages.
DriveKit Common UI contains a number of basic text keys used in other DriveKit UI modules. You can override these keys to customize your application.
To help make the text keys in the code easier to read, a specific nomenclature has been set up:
dk_<module name>_<key description>.For the Common UI module, all localizable keys are prefixed with:
dk_common.There are several files containing text keys:
- A string.xml file in the common UI module containing generic keys to all modules.
- One file per UI module containing module-specific text keys.
You can override any texts to customize your application. To override a text key, simply define the keys to be modified in a string.xml file at the application level. The text keys can be directly retrieved on Github, in the src/main/res/values folder of each module.
The translation file can be retrieved from GitHub in the various DriveKit UI modules and integrated into the values-<Locale> folder of the app.
You can retrieve some data and build analytics for any DriveKit UI component. To enable the feature, call the following method:
Kotlin
Java
DriveKitUI.configureAnalytics(object: DriveKitAnalyticsListener{
override fun trackScreen(screen: String, className: String) {
// TODO: manage screen tracking here
}
override fun trackEvent(event: DKAnalyticsEvent, parameters: Map<DKAnalyticsEventKey, String>) {
// TODO: manage event tracking here
}
})
DriveKitUI.INSTANCE.configureAnalytics(new DriveKitAnalyticsListener() {
@Override
public void trackScreen(@NotNull String screen, @NotNull String className) {
// TODO: manage screen tracking here
}
@Override
public void trackEvent(@NotNull DKAnalyticsEvent event, @NotNull Map<DKAnalyticsEventKey, String> parameters) {
// TODO: manage event tracking here
}
});
trackScreen() method is called when a screen is displayed (i.e. trips list, trip detail, etc.).When the method is called, you just have to call your analytics solution like Google Analytics for Firebase.
The
screen String received in the trackScreen method is the value associated with one of the keys in this array, corresponding to the visited screen.In order to customize screens values, you have to override keys you can find in dk_analytics.xml in each DriveKit UI component.
trackEvent() allows adding additional information that may be useful for analysis. For example, that method is triggered each time the user is opening the trip detail screen.Last modified 6mo ago