@triarensplugins/drplugin NPM

@triarensplugins/drplugin

Overview

The @triarensplugins/drplugin plugin is designed for use with NativeScript and provides functionality for handling damage reporting within your mobile app. This plugin supports both iOS and Android platforms, with specific requirements for each.

Requirements

Before you get started, please ensure that your project meets the following platform-specific requirements:

iOS: Minimum version 15.0.
Android: Minimum SDK version 27.

Installation

You can easily add the @triarensplugins/drplugin plugin to your NativeScript project using the following command:

tns plugin add @triarensplugins/drplugin

iOS Permissions

To use this plugin on iOS, you need to include the following permissions in your app's info.plist file:

<key>NSCameraUsageDescription</key>
<string>enter your camera permission request text here</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>enter your photo library permission request text here</string>
<key>NSCalendarsUsageDescription</key>
<string>enter your calendar permission request text here</string>
<key>NSCalendarsWriteOnlyAccessUsageDescription</key>
<string>enter your calendar permission request text here (for iOS17)</string>

Make sure to replace the placeholder text with the actual permission request messages that are appropriate for your app.

Usage

In XML

Add the plugin namespace to your XML file using the following line:

xmlns:ui="@triarensplugins/drplugin"

Use the <ui:DRView> element in your XML layout to integrate the damage reporting view.

<ui:DRView baseUrl="PROVIDED_BASE_URL" mandatorId="PROVIDED_MANDATOR_ID" phoneNumber="PROVIDED_PHONE_NUMBER" />

Here are the attributes you should set for <ui:DRView:

baseUrl: Provided by "B&O."
mandatorId: Special ID string provided by "B&O."
phoneNumber: Hotline number provided by "B&O."

Example XML

<Page
    navigatingTo="onNavigatingTo"  
    xmlns="http://schemas.nativescript.org/tns.xsd" 
    xmlns:ui="@triarensplugins/drplugin">
    <ui:DRView baseUrl="PROVIDED_BASE_URL" mandatorId="PROVIDED_MANDATOR_ID" phoneNumber="PROVIDED_PHONE_NUMBER" />
</Page>

Customization

You can change the colors of the damage reporting view to match your app's theme. The available color names are as follows:

primaryColor
backgroundLight
backgroundDark
secondaryLight
secondaryDark
error
emergency
primaryTextLight
primaryTextDark
secondaryTextLight
secondaryTextDark
borderLight
borderDark

For example, to change the primaryColor and backgroundLight:

<ui:DRView baseUrl="PROVIDED_BASE_URL" mandatorId="PROVIDED_MANDATOR_ID" phoneNumber="PROVIDED_PHONE_NUMBER" 
        primaryColor="#32a852"
        backgroundLight="green"/>