
<!-- Auto Generated Below -->


## SignetCheckbox Properties

| Property                | Attribute                 | Description                                                              | Type      | Default      |
| ----------------------- | ------------------------- | ------------------------------------------------------------------------ | --------- | ------------ |
| `checked`               | `checked`                 | Indicates whether the checkbox is checked.                               | `boolean` | `false`      |
| `disabled`              | `disabled`                | Indicates whether the checkbox is disabled.                              | `boolean` | `false`      |
| `label`                 | `label`                   | The text label displayed next to the checkbox                            | `string`  | `undefined`  |
| `name`                  | `name`                    | The name attribute of the checkbox input element.                        | `string`  | `undefined`  |
| `required`              | `required`                | Indicates whether the checkbox is required.                              | `boolean` | `undefined`  |
| `requiredAsteriskColor` | `required-asterisk-color` | The color of the required asterisk in the label. Defaults to 'red'.      | `string`  | `'red'`      |
| `requiredText`          | `required-text`           | Text displayed for accessibility purposes when the checkbox is required. | `string`  | `"Required"` |
| `value`                 | `value`                   |                                                                          | `string`  | `undefined`  |


## SignetCheckbox Events

| Event     | Description | Type                          |
| --------- | ----------- | ----------------------------- |
| `changed` |             | `CustomEvent<IFormFieldData>` |


## SignetCheckbox Methods

### `validate() => Promise<IFormFieldData>`


#### Returns

Type: `Promise<IFormFieldData>`


## Dependencies

### Used by

 - [datagrid-filter-checkbox](../datagrid-filters)
 - [datagrid-filter-checkbox-eligible-year](../datagrid-filters)
 - [demo-signet-select](../demo-signet-select)

### Graph
```mermaid
graph TD;
  datagrid-filter-checkbox --> signet-checkbox
  datagrid-filter-checkbox-eligible-year --> signet-checkbox
  demo-signet-select --> signet-checkbox
  style signet-checkbox fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with Signet Design System*