1.6.0 • Published 1 year ago

@modea/capacitor-salesforce-chat v1.6.0

Weekly downloads
-
License
MIT
Repository
bitbucket
Last release
1 year ago

@modea/capacitor-salesforce-chat

Capacitor plugin that launches salesforce chat ui

Setup

cd ios && pod install && cd ..

Local Development

From the root of this repo run npm link. Then, from the consuming library, run npm link @modea/capacitor-salesforce-chat. Run npm run sync and then build the app to verify changes to the plugin.

Install

npm install @modea/capacitor-salesforce-chat
npx cap sync

API

startChat(...)

startChat(options: SalesforceChatConfiguration) => Promise<{ success: boolean; }>
ParamType
optionsSalesforceChatConfiguration

Returns: Promise<{ success: boolean; }>


setBrandingColors(...)

Only available for ios

To change branding colors for android overwrite the salesforce colors in one of your resource files

setBrandingColors(colors: SalesforceBrandingColors) => Promise<{ success: boolean; }>
ParamType
colorsSalesforceBrandingColors

Returns: Promise<{ success: boolean; }>


Interfaces

SalesforceChatConfiguration

PropTypeDefault
orgIdstring
deploymentIdstring
buttonIdstring
liveAgentPodstring
defaultToMinimizedboolean?false
visitorNamestring?"Visitor"

SalesforceBrandingColors

All of these are optional change what you want

PropTypeDefaultDescription
navbarBackgroundstring?#FAFAFABackground of input section
navbarInvertedstring?#010101Minimize and close button colors
brandPrimarystring?#007F7FColor of text cursor
brandSecondarystring?#2872CCSelf text bubble background
brandSecondaryInvertedstring?#FCFCFCSelf text bubble text
contrastPrimarystring?#000000Agent text bubble text
contrastInvertedstring?#FFFFFFAgent text bubble background
contrastSecondarystring?#6D6D6DBackground fade on navbar
contrastQuaternarystring?#F1F1F1Background of chat area
1.6.0

1 year ago

1.5.0

2 years ago

1.4.0

2 years ago

1.3.0

2 years ago

1.2.0

2 years ago

1.1.0

3 years ago

1.0.0

3 years ago

0.1.0

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago