@dile/dile-checkbox

@dile/dile-checkbox

Web Component to create a customized checkbox input interface, based on LitElement.

Installation

npm i @dile/dile-checkbox

Usage

<script type="module">
  import '@dile/dile-checkbox/dile-checkbox.js';
</script>

<dile-checkbox>Label for the checkbox element</dile-checkbox>

Properties

• checked: Boolean, defines the checkbox state.
• disabled: Boolean, mark checkbox as disabled.
• name: The name of the checkbox, only for identification purposes

There is a special value property. This is not a actual component property but it mirrors the checked property, because sometimes forms colud use this property instead of checked to query or change its state.

Custom events

• dile-checkbox-changed: Every time the checkbox changes emits a dile-checkbox-changed event. The checkbox current state is received in the handler usign the event object "detail" property.

when fired, the custom event sends a detail object, containing the checked state of the element and the value of the name property.

• element-changed: this event is dispatched when the cheked property changes. The event detail emmit the name, checked and value property.

CSS Custom Properties

You can customize it using CSS Custom Properties.

Custom property	Description	Default
--dile-checkbox-checked-color	Checked color for check control	#30a030
--dile-checkbox-unchecked-color	Unchecked color for check control	#ccc
--dile-checkbox-fill-color	Fill color for the check control	#fff
--dile-checkbox-unchecked-fill-color	Checked color for check control when is in unchecked status	#fff
--dile-checkbox-label-color	label regular color	#303030
--dile-checkbox-label-disabled-color	Label color for disabled status	#303030
--dile-checkbox-font-weight	Font weight for te label	normal
--dile-checkbox-size	Checkbox size	20px

Customization example

<style>
.customized {
  --dile-checkbox-checked-color: #006;
  --dile-checkbox-unchecked-color: #f66;
  --dile-checkbox-fill-color: #fcc;
  --dile-checkbox-unchecked-fill-color: #666;
  --dile-checkbox-label-color: #c57;
  --dile-checkbox-font-weight: bold;
  --dile-checkbox-label-disabled-color: #ddd;
}
</style>

<dile-checkbox checked class="customized">Mark as urgent</dile-checkbox>