Adds an "SMS" action to the actions menu that opens a form for the user to send themselves a text message with item details. Uses Primo's email API to send item details to carrier SMS gateways to convert them to text messages.
- Make sure you've installed and configured primo-explore-devenv.
- Navigate to your template/central package root directory. For example:
- If you do not already have a
package.jsonfile in this directory, create one:
npm init -y
- Install this package:
npm install primo-explore-send-sms --save
alternatively, just copy
dist/module.js into your package's
n.b. This customization depends on primo-explore-custom-actions. If you didn't install using
npm, you'll need to also manually install the custom actions package.
Once this package is installed, add
sendSms as a dependency for your custom module definition.
var app = angular
Note: If you're using the
--browserify build option, you will need to first import the module with:
Activate the customization by adding an
<sms-action /> element as part of your
prmActionListAfter component template:
You can configure the look of the action and the available SMS carriers by passing a new options object as
smsOptions - see below for an example.
smsOptions.smsActionproperty governs the look of the action - see primo-explore-custom-actions for more info on how to customize it.
smsOptions.smsCarriersproperty governs the available SMS carriers, and is a map of carrier options to their respective SMS gateway addresses.
You can see the default options for both properties by looking at
src/js/smsOptions.value.js in this repository.
The example below activates the customization and changes the action label to 'Text Me'. It also moves the action to the left side of the list, and shortens the list of available SMS carriers.
var app = angularappappvalue'smsOptions'smsAction:name: 'send_sms'label: 'Text Me'index: 0icon:icon: 'ic_smartphone_24px'iconSet: 'hardware'type: 'svg'smsCarriers:'ATT': 'txt.att.net''T-Mobile': 'tmomail.net''Verizon': 'vtext.com'