Skip to content

todo-list.md

Latest commit

 

History

History
39 lines (32 loc) · 1.15 KB

todo-list.md

File metadata and controls

39 lines (32 loc) · 1.15 KB
layout page
title Todo List Plugin

The todo list plugin provides simple functionality to the todo list component.

Usage

This plugin can be activated as a jQuery plugin or using the data api.

Data API

{: .text-bold } Activate the plugin by adding data-widget="todo-list" to the ul element. If you need to provide onCheck and onUncheck methods, please use the jQuery API.

jQuery

{: .text-bold } The jQuery API provides more customizable options that allows the developer to handle checking and unchecking the todo list checkbox events.

$('#my-todo-list').TodoList({
  onCheck: function(checkbox) {
    // Do something when the checkbox is checked
  },
  onUnCheck: function(checkbox) {
    // Do something after the checkbox has been unchecked
  }
})
Options

{: .mt-4}

|---

Name Type Default Description
onCheck Function Anonymous Function Handle checkbox onCheck event. The checkbox is passed as parameter to the function.
onUnCheck Function Anonymous Function Handle checkbox onUnCheck event. The checkbox is passed as parameter to the function.
---
{: .table .table-bordered .bg-light}