@dpa-id-components/ui-checkbox

UiCheckBox Vue 2.x input component based on the dpa Design Kit

Installation

yarn add @dpa-id-components/ui-checkbox

Usage

<template>
  <ui-checkbox />
</template>

<script>
  import UiCheckBox from "@dpa-id-components/ui-component";

  export default {
    components: {
      UiCheckBox,
    }
  };
</script>

Demo

View a demo of <ui-checkbox> on Storybook

API

Props

| Name | Type | Default | Description | | --------------- | --------- | ------- |---------------------------------------- | | checked | Boolean | false | Wether the checkbox is checked | | disabled | Boolean | true | Wether the checkbox is disabled | | isValid | Boolean | true | Wether the checkbox field is valid | | errorMessage | String | "" | Error message text to be displayed |

Events

| Name | Type | Description | | ------- |---------------- | -------------------------------------- | | click | ClickEvent | triggerd when the checkbox is clicked|