Character Count Plug-in

Introduction

This article introduces the Character Count Plug-in, which is a plug-in version of the sample code introduced in the "Character count" article.

This plug-in counts the number of characters in a Text Area field (excluding spaces and line breaks) and stores the number in the specified Number field upon saving the record.

Plug-in file

The packaged sample plug-in zip file can be downloaded from the Releases page on GitHub.
Install the plug-in into your domain by following the plug-in installation guide on the Help page.
You can then add the plug-in to a specific App by following the plug-in adding guide on the Help page.

Overview

To set up the plug-in, the Kintone App must have a Text Area field and a Number field set in its form.

Image_5.png

 

There are two settings for this plug-in.

For the first setting, select a Text Area field from the drop-down list.
For the second setting, select a Number field from the drop-down list.


Image_7.png

 

After saving the plug-in settings and updating the App, the plug-in's features will run when a record is saved, by counting the number of characters (excluding spaces and line breaks) in the specified Text Area field, and then inserting the number into the specified Number field.
The Number field is also set to be un-editable while the user enters information into the record.

 

sample001.gif

 

File structure

The sample codes used in the plug-in are listed under the src file in our GitHub repository.

The plug-in is created with the following file structure:

 

plug-in/
├── html/
│            └──── config.html
├── css/
│            ├──── 51-modern-default.css
│            └──── config.css
├── js/
│            ├──── config.js
│            └──── desktop.js
├── image/
│            └──── characters.png
└── manifest.json

 

config.html

This file builds the HTML of the plug-in settings page.
Each <div> tag with the "block" class represents 1 row of related HTML elements.

charactercount_settingspage.png


The first "block" contains the HTML of the first settings, where the user chooses which Text Area field will have their characters counted. A select tag is stated in the HTML, that creates a drop-down field with a value of "-----". This drop-down field is later populated by the config.js file.

<div class="block">
<label class="kintoneplugin-label">
<span id ="container_label">Field to Count</span>
<span class="kintoneplugin-require">*</span>
</label>
<div class="kintoneplugin-row">Please select a Text Area field</div>
<div class="kintoneplugin-select-outer">
<div class="kintoneplugin-select">
<select id="select_body_field" name="select_body_field">
<option value="">-----</option>
</select>
</div>
</div>
</div>

The second "block" contains the HTML of the second settings, where the user chooses which Number field will store the number of counted characters. Similar to the first settings, a select tag is stated in the HTML that creates a drop-down field with a value of "-----". This drop-down field is also later populated by the config.js file.

<div class="block">
<label class="kintoneplugin-label">
<span id ="container_label">Field to Store Character Counts</span>
<span class="kintoneplugin-require">*</span>
</label>
<div class="kintoneplugin-row">Please select a Number field</div>
<div class="kintoneplugin-select-outer">
<div class="kintoneplugin-select">
<select id="select_count_field" name="select_count_field">
<option value="">-----</option>
</select>
</div>
</div>
</div>

Both drop-down fields in the blocks have ids allocated to them, so that they can be targeted and populated by the config.js file.

51-modern-default.css

This CSS file is provided on GitHub. This file styles HTML elements on the plug-in config page to fit in with Kintone's UI.
We recommend that you do not make changes to 51-modern-default.css. If you need to style additional elements, or over-ride the default styles, those changes should be added into config.css.

config.css

This supporting CSS file is used to style some areas of the plug-in config page that 51-modern-default.css doesn't cover.

config.js

The function setDropDown is called when the plug-in setting page loads. It uses the kintone.api() wrapper from the JavaScript API to call the REST API endpoint Get Form Fields. Get Form Fields returns an object that contains the form fields for the specified App.
Depending on the endpoint called, Get Form Fields can return either the deployed form fields (the user has clicked Update App in the App Settings and the changes have been committed) or the preview form fields (the form has been saved in the App settings, but the user has not clicked Update App and committed them). This function uses the preview endpoint as users may access the plug-in settings page before they are ready to commit their changes.

function setDropDown() {
    // Retrieve field information, then set dropdown
    return kintone.api(kintone.api.url('/k/v1/preview/app/form/fields', true), 'GET',
        {'app': kintone.app.getId()}).then(function(resp) {
...
...
//run rest of code here after retrieving preview form information
//resp contains the response data
...
... }, function(resp) { return alert('Failed to retrieve field information'); }); }

As this plug-in needs to use the Text Area fields and Number fields to populate the drop-down fields  in the plug-in settings, the fields with type value of MULTI_LINE_TEXT (the Text Area field) and NUMBER (the Number field) are extracted from the returned object. The extracted selections are then appended to the element with the ids of select_body_field and select_count_field to make a drop-down list of Text Area fields and Number fields in the App.

for (var key in resp.properties) {
    if (!resp.properties.hasOwnProperty(key)) {
        continue;
    }
    var prop = resp.properties[key];
    var $option = $('');

    switch (prop.type) {
        case 'MULTI_LINE_TEXT':
            $option.attr('value', prop.code);
            $option.text(escapeHtml(prop.label));
            $('#select_body_field').append($option.clone());
            break;
        case 'NUMBER':
            $option.attr('value', prop.code);
            $option.text(escapeHtml(prop.label));
            $('#select_count_field').append($option.clone());
            break;
        default:
            break;
    }
}

At the end of the setDropDown function, the code checks the CONF object where any saved setting data are stored. If it's the first time for the user to use the plug-in, there are no saved values, thus no values are placed in the settings of the plug-in settings page. If the user has saved any settings before in the plug-in (which are stored using Kintone's setConfig API), then those saved values (the specified Text Area field and Number field) are inserted into the designated plug-in settings.

// Set default values
$('#select_body_field').val(CONF.body);
$('#select_count_field').val(CONF.count);

desktop.js

This file runs on the regular pages of the App, such as the Record List and Record Details pages, but not on the App Settings page. This file uses the sample code included in the "Character count" article. The code used in this plug-in is mostly the same, but it's wrapped in an immediate function with the plug-in ID value as the input parameter. The plug-in ID value is needed for several JavaScript API calls, such as Kintone's getConfig API that retrieves the configuration data that was saved in the plug-in settings page using the setConfig API.

// Get plug-in configuration settings
var CONFIG = kintone.plugin.app.getConfig(PLUGIN_ID);

Data retrieved with the kintone.plugin.app.getConfig(PLUGIN_ID) method are allocated to variables in the code.

var CONFIG_BODY = CONFIG.body;
var CONFIG_COUNT = CONFIG.count;

These variables are used when the app.record.create.submitapp.record.edit.submit or app.record.index.edit.submit events (events triggered when records are saved) are triggered to specify the related properties within the event object.
Overwriting values within the event object and returning the object results in specific fields of the App record to be overwritten - in this case, the Number field is overwritten with new data.

kintone.events.on(['app.record.create.submit', 'app.record.edit.submit', 'app.record.index.edit.submit'],
    function(event) {
        // Obtain characters in the text field
        var rec = event.record;
        var st = rec[CONFIG_BODY].value;

        // If the number of characters is zero, put zero in number field and return
        if (!st) {
            rec[CONFIG_COUNT].value = 0;
            return event;
        }

        //Remove spaces
        var st2 = st.replace(/\s+/g, "");

        //Enter character count into number field
        rec[CONFIG_COUNT].value = st2.length;

        return event;
    });

manifest.json

The manifest file states the paths of the files that will be used in the plug-in. It also links to the jQuery library hosted on the Kintone CDN, so that it can be called in the other JavaScript files.

"js": [
"https://js.kintone.com/jquery/3.3.1/jquery.min.js",
"js/config.js"
]

The array in the value of the required_params key states which settings in the plug-in config page are required. If these settings are not saved using the setConfig API, errors will be displayed on other pages of the App, stating that the plug-in settings have not been configured yet.

"required_params": [
"body",
"count"
]

The namedescription, and homepage_url key-value pairs are labels and links displayed in the plug-in settings.

"name": {
"en": "Character Count Plug-in"
},
"description": {
"en": "This sample code counts the total number of characters in a Text Area field. Spaces in the Text Area field are excluded from the count. The final count value is set into a Number field."
},
"homepage_url": {
"en": "https://developer.kintone.io/hc/en-us/articles/360010158273"
}

Finally

Licenses

This plug-in is open sourced under the MIT License. It allows open- or closed-sourced distribution, including commercial use.
If you would like to add more functionality to the plug-in, you are welcome to clone our repository to make your own changes and redistribute it. We generally do not accept external pull requests for the sample plug-in as this repository exists for educational purposes.

If you have any questions related to building Kintone plug-ins, please post your question in the kintone developer network community.

Contribution

This sample plug-in was created with the contribution of Fuji Business International
https://www.linkedin.com/in/mfujinoki/

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!