:orphan:

.. _checkbox:

======================================
checkbox
======================================

How to write by SpWML
========================

.. code-block:: none
   
   (checkbox, sid:cb1)
   +(menu)menu 1
   +(menu)menu 2
   +(menu)menu 3
   // primary color, icon right.
   (checkbox, isV3:true, isPrefixIcon:false, w:100, sid:cb2)
   +(menu)aaa
   +(menu)bbb
   +(menu)ccc

----

Summary
===============

This block allows you to create checkboxes.

It is necessary to set the SID.

It has not only `Checkbox class <https://api.flutter.dev/flutter/material/Checkbox-class.html>`__ variables that has variables that have been further adjusted to improve usability.

To use this type, it is necessary to set `MultiFlagManager <https://pub.dev/packages/simple_managers>`__  to SpWMLBuilder or SpWML widget. 

With this type, the manager always stores the value associated with the SID.

----

Dart Class Reference
======================
`CheckboxElement class <https://pub.dev/documentation/simple_widget_markup/latest/simple_widget_markup/CheckboxElement-class.html>`__

----

SpWML Parameters
====================

* :ref:`The common<spwml>` parameters.
* :ref:`Parent<multi_child>` parameters.
* iconSize (double). Set size of icon in px.
* iconColor (String). Color setting. :ref:`The color system<color_system>` .
* splashRadius (double). Set the size of the reaction circle by px on when tapped.
* enableTapLabel (bool). If true, can tap text. The initial value is false.
* isV3 (bool). If true, the checkbox color will be the system primary color. Also, the icon changes to a solid type.
* isPrefixIcon (bool). Default is true, if false the icon is aligned to the right. Note that you may need to specify the width as well, as the text portion will autostretch.
* isEnabled (bool). Set to false if you want to disable this elements.