.. include:: /Includes.rst.txt .. _columns-check: ============== type = 'check' ============== .. _columns-check-introduction: Introduction ============ This type creates checkbox(es). There can be between 1 and 31 checkboxes. The corresponding database field must be of type integer. Each checkbox corresponds to a single bit of the integer value, even if there is only one checkbox. .. tip:: This means that you should check the bits of values from single-checkbox fields and not just whether it is true or false. .. warning:: Resorting the 'items' of a type='check' config results in single items moving to different bit positions. It might be required to migrate existing field data if doing so. The following renderTypes are available: * :ref:`default `: One or more checkboxes are displayed. * :ref:`checkboxToggle `: Instead of checkboxes, a toggle item is displayed. * :ref:`checkboxLabeledToggle `: A toggle switch where both states can be labelled (ON/OFF, Visible / Hidden or alike). Its state can be inverted via :code:`invertStateDisplay` .. toctree:: :hidden: checkDefault checkboxToggle checkboxLabeledToggle