Skip to content

Checkbox chargeable plugin

The Checkbox plugin provides a to-do function, which means adding a checkbox to a node. Clicking on the checkbox can switch between completed and incomplete states.

You can experience it in the online version by right clicking on the node and clicking on 'Add ToDo'.

Charge

Scanning the code and transferring money, please note the plugin you want to purchase and your email address(If you reach the maximum text limit, you can make the payment in two installments), and then the plugin file will be sent to your email. Purchase should be made after full use and consideration. If you are not familiar with front-end development and do not know how to use plugins, please consider purchasing carefully. There will be no refund unless there are special reasons. If you find bugs or have requirements, you can submit relevant issues.

Price: ¥ 29.9, including unpackaged source code and packaged files.

Register

1.Referencing packaged files:

js
import MindMap from 'simple-mind-map'
import Checkbox from 'checkbox.cjs.min.js'
// 或 import Checkbox from 'checkbox.esm.min.js'

MindMap.usePlugin(Checkbox)

2.Referencing Unpackaged Source Code

You can first enter the plugin directory to execute:

bash
npm link

Then enter your project root directory to execute:

bash
npm link simple-mind-map-plugin-checkbox

Then you can directly import it for use:

js
import MindMap from 'simple-mind-map'
import Checkbox from 'simple-mind-map-plugin-checkbox'

MindMap.usePlugin(Checkbox, opt)

After registration and instantiation of MindMap, the instance can be obtained through mindMap.checkbox.

When registering plugins, it is supported to pass in some configuration items 'opt':

Field nameTypeDefaultDesc
widthNumber20The size of the to-do icon
heightNumber20The size of the to-do icon
checkedIconStringTo do completed icon, SVG string. If not specified, the default icon will be used. It is important to remove the fill attribute from the SVG string, otherwise the color may not take effect
unCheckedIconStringIcon for pending tasks, SVG string
colorIsFollowNodeBooleantrueDoes the icon color follow the color of the node text
colorString#3f9cfcIf colorIsRollowNode is set to false, this color will be used

Command

After registering this plugin, the 'SET_CHECKBOX' command will be added to the mind map instance to set node numbers. Use this command:

js
mindMap.execCommand('SET_CHECKBOX', appointNodes, checkboxData)

This command can pass two parameters:

  • appointNodes:Set to-do data for a specified node instance, which can be passed as a single node instance or as an array of node instances. If an empty array is passed, a to-do will be added to the currently activated node;

  • checkboxData:To set the to-do data, if 'null' is passed, it means deleting the to-do. Otherwise, please pass an object with the following detailed fields:

Field nameTypeDesc
doneBooleanHas the to-do list been completed

Example:

js
mindMap.execCommand('SET_CHECKBOX', [], {
   done: false
})

After setting the number, the data will be saved to the node's' data 'under the name 'checkbox'.

MIT License.