---
title: "IUICheckBox"
---
# IUICheckBox

Defined in: [src/types/ui.d.ts:197](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L197)

## Extends

- [`IUIInput`](./types.IUIInput.html)

### mods

**mods**: [`IDictionary`](../modules/types.html#idictionary)\<[`ModType`](../modules/types.html#modtype)\>

Defined in: [src/types/traits.d.ts:28](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L28)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`mods`](./types.IUIInput.html#mods)

***

### async

`readonly` **async**: [`IAsync`](./types.IAsync.html)

Defined in: [src/types/types.d.ts:43](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L43)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`async`](./types.IUIInput.html#async)

***

### ownerDocument

`readonly` **ownerDocument**: [`Document`](https://developer.mozilla.org/docs/Web/API/Document)

Defined in: [src/types/types.d.ts:44](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L44)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`ownerDocument`](./types.IUIInput.html#ownerdocument)

***

### od

`readonly` **od**: [`Document`](https://developer.mozilla.org/docs/Web/API/Document)

Defined in: [src/types/types.d.ts:45](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L45)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`od`](./types.IUIInput.html#od)

***

### ownerWindow

`readonly` **ownerWindow**: [`Window`](https://developer.mozilla.org/docs/Web/API/Window)

Defined in: [src/types/types.d.ts:46](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L46)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`ownerWindow`](./types.IUIInput.html#ownerwindow)

***

### ow

`readonly` **ow**: [`Window`](https://developer.mozilla.org/docs/Web/API/Window)

Defined in: [src/types/types.d.ts:47](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L47)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`ow`](./types.IUIInput.html#ow)

***

### componentName

`readonly` **componentName**: `string`

Defined in: [src/types/types.d.ts:51](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L51)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`componentName`](./types.IUIInput.html#componentname)

***

### uid

`readonly` **uid**: `string`

Defined in: [src/types/types.d.ts:62](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L62)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`uid`](./types.IUIInput.html#uid)

***

### isDestructed

`readonly` **isDestructed**: `boolean`

Defined in: [src/types/types.d.ts:63](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L63)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`isDestructed`](./types.IUIInput.html#isdestructed)

***

### isInDestruct

`readonly` **isInDestruct**: `boolean`

Defined in: [src/types/types.d.ts:64](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L64)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`isInDestruct`](./types.IUIInput.html#isindestruct)

***

### isReady

`readonly` **isReady**: `boolean`

Defined in: [src/types/types.d.ts:65](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L65)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`isReady`](./types.IUIInput.html#isready)

***

### componentStatus

`readonly` **componentStatus**: [`ComponentStatus`](../modules/types.html#componentstatus)

Defined in: [src/types/types.d.ts:67](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L67)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`componentStatus`](./types.IUIInput.html#componentstatus)

***

### jodit

**jodit**: [`IViewBased`](./types.IViewBased.html)

Defined in: [src/types/types.d.ts:79](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L79)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`jodit`](./types.IUIInput.html#jodit)

***

### j

`readonly` **j**: [`IViewBased`](./types.IViewBased.html)

Defined in: [src/types/types.d.ts:80](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L80)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`j`](./types.IUIInput.html#j)

***

### i18n

`readonly` **i18n**: (`text`, ...`params`) => `string`

Defined in: [src/types/types.d.ts:82](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L82)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| ...`params` | (`string` \| `number`)[] |

#### Returns

`string`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`i18n`](./types.IUIInput.html#i18n)

***

### defaultTimeout

`readonly` **defaultTimeout**: `number`

Defined in: [src/types/types.d.ts:83](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L83)

#### Inherited from

[`IViewComponent`](./types.IViewComponent.html).[`defaultTimeout`](./types.IViewComponent.html#defaulttimeout)

***

### parentElement

**parentElement**: [`Nullable`](../modules/types.html#nullable)\<[`IUIElement`](./types.IUIElement.html)\>

Defined in: [src/types/ui.d.ts:26](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L26)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`parentElement`](./types.IUIInput.html#parentelement)

***

### container

**container**: [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)

Defined in: [src/types/ui.d.ts:27](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L27)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`container`](./types.IUIInput.html#container)

***

### name

**name**: `string`

Defined in: [src/types/ui.d.ts:28](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L28)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`name`](./types.IUIInput.html#name)

***

### nativeInput

`readonly` **nativeInput**: [`HTMLTextAreaElement`](https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement) \| [`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement) \| [`HTMLSelectElement`](https://developer.mozilla.org/docs/Web/API/HTMLSelectElement)

Defined in: [src/types/ui.d.ts:134](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L134)

#### Inherited from

[`IUIRange`](./types.IUIRange.html).[`nativeInput`](./types.IUIRange.html#nativeinput)

***

### value

**value**: `string`

Defined in: [src/types/ui.d.ts:153](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L153)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`value`](./types.IUIInput.html#value)

***

### error

**error**: `string`

Defined in: [src/types/ui.d.ts:154](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L154)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`error`](./types.IUIInput.html#error)

***

### isFocused

`readonly` **isFocused**: `boolean`

Defined in: [src/types/ui.d.ts:158](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L158)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`isFocused`](./types.IUIInput.html#isfocused)

***

### state

`readonly` **state**: `object` & `object`

Defined in: [src/types/ui.d.ts:198](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L198)

##### className

**className**: `string`

##### autocomplete

**autocomplete**: `boolean`

##### name

**name**: `string`

##### value

**value**: `string` \| `number`

##### icon

**icon**: `string`

##### label

**label**: `string`

##### ref

**ref**: `string`

##### type

**type**: `"number"` \| `"text"` \| `"checkbox"` \| `"url"` \| `"file"` \| `"hidden"`

##### placeholder

**placeholder**: `string`

##### required

**required**: `boolean`

##### validators

**validators**: `string`[]

##### clearButton?

`optional` **clearButton?**: `boolean`

##### onChange?

`optional` **onChange?**: (`value`) => `void`

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

##### checked

**checked**: `boolean`

##### switch

**switch**: `boolean`

#### Overrides

[`IUIInput`](./types.IUIInput.html).[`state`](./types.IUIInput.html#state)

### setMod()

**setMod**\<`T`\>(`this`, `name`, `value`): `T`

Defined in: [src/types/traits.d.ts:20](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L20)

Set/remove modification (null - remove)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`IComponent`](./types.IComponent.html)\<[`IViewBased`](./types.IViewBased.html)\<[`IViewOptions`](./types.IViewOptions.html)\>\> & [`IContainer`](./types.IContainer.html) & [`IMods`](./types.IMods.html) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `this` | `T` |
| `name` | `string` |
| `value` | [`ModType`](../modules/types.html#modtype) |

#### Returns

`T`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`setMod`](./types.IUIInput.html#setmod)

***

### afterSetMod()

**afterSetMod**(`name`, `value`): `void`

Defined in: [src/types/traits.d.ts:25](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L25)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |
| `value` | [`ModType`](../modules/types.html#modtype) |

#### Returns

`void`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`afterSetMod`](./types.IUIInput.html#aftersetmod)

***

### getMod()

**getMod**(`name`): [`ModType`](../modules/types.html#modtype)

Defined in: [src/types/traits.d.ts:27](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L27)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | `string` |

#### Returns

[`ModType`](../modules/types.html#modtype)

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getMod`](./types.IUIInput.html#getmod)

***

### getElm()

**getElm**(`elementName`): [`Nullable`](../modules/types.html#nullable)\<[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)\>

Defined in: [src/types/traits.d.ts:32](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L32)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `elementName` | `string` |

#### Returns

[`Nullable`](../modules/types.html#nullable)\<[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)\>

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getElm`](./types.IUIInput.html#getelm)

***

### getElms()

**getElms**(`elementName`): [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)[]

Defined in: [src/types/traits.d.ts:33](https://github.com/xdan/jodit/blob/main/src/types/traits.d.ts#L33)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `elementName` | `string` |

#### Returns

[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)[]

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getElms`](./types.IUIInput.html#getelms)

***

### destruct()

**destruct**(`jodit?`): `any`

Defined in: [src/types/types.d.ts:32](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L32)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `jodit?` | [`IViewBased`](./types.IViewBased.html)\<[`IViewOptions`](./types.IViewOptions.html)\> |

#### Returns

`any`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`destruct`](./types.IUIInput.html#destruct)

***

### get()

**get**\<`T`\>(`chain`, `obj?`): [`Nullable`](../modules/types.html#nullable)\<`T`\>

Defined in: [src/types/types.d.ts:49](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L49)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `chain` | `string` |
| `obj?` | [`IDictionary`](../modules/types.html#idictionary)\<`any`, `string`\> |

#### Returns

[`Nullable`](../modules/types.html#nullable)\<`T`\>

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`get`](./types.IUIInput.html#get)

***

### className()

**className**(): `string`

Defined in: [src/types/types.d.ts:52](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L52)

#### Returns

`string`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`className`](./types.IUIInput.html#classname)

***

#### Call Signature

**getFullElName**(`elementName`): `string`

Defined in: [src/types/types.d.ts:54](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L54)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `elementName` | `string` |

##### Returns

`string`

##### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getFullElName`](./types.IUIInput.html#getfullelname)

#### Call Signature

**getFullElName**(`elementName`, `mod`): `string`

Defined in: [src/types/types.d.ts:55](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L55)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `elementName` | `string` |
| `mod` | `string` |

##### Returns

`string`

##### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getFullElName`](./types.IUIInput.html#getfullelname)

#### Call Signature

**getFullElName**(`elementName`, `mod?`, `modValue?`): `string`

Defined in: [src/types/types.d.ts:56](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L56)

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `elementName` | `string` |
| `mod?` | `string` |
| `modValue?` | `string` \| `boolean` |

##### Returns

`string`

##### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getFullElName`](./types.IUIInput.html#getfullelname)

***

### setStatus()

**setStatus**(`componentStatus`): `void`

Defined in: [src/types/types.d.ts:68](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L68)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `componentStatus` | [`ComponentStatus`](../modules/types.html#componentstatus) |

#### Returns

`void`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`setStatus`](./types.IUIInput.html#setstatus)

***

### hookStatus()

**hookStatus**(`status`, `callback`): `void`

Defined in: [src/types/types.d.ts:70](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L70)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `status` | [`ComponentStatus`](../modules/types.html#componentstatus) |
| `callback` | (`component`) => `void` |

#### Returns

`void`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`hookStatus`](./types.IUIInput.html#hookstatus)

***

### bindDestruct()

**bindDestruct**(`component`): `this`

Defined in: [src/types/types.d.ts:75](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L75)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `component` | [`IComponent`](./types.IComponent.html) |

#### Returns

`this`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`bindDestruct`](./types.IUIInput.html#binddestruct)

***

### setParentView()

**setParentView**(`jodit`): `this`

Defined in: [src/types/types.d.ts:81](https://github.com/xdan/jodit/blob/main/src/types/types.d.ts#L81)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `jodit` | [`IViewBased`](./types.IViewBased.html) |

#### Returns

`this`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`setParentView`](./types.IUIInput.html#setparentview)

***

### getRole()

**getRole**(): `string`

Defined in: [src/types/ui.d.ts:30](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L30)

#### Returns

`string`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`getRole`](./types.IUIInput.html#getrole)

***

### bubble()

**bubble**(`callback`): `this`

Defined in: [src/types/ui.d.ts:35](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L35)

Apply callback for all parents

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `callback` | (`parent`) => `void` |

#### Returns

`this`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`bubble`](./types.IUIInput.html#bubble)

***

#### Call Signature

**closest**\<`T`\>(`type`): [`Nullable`](../modules/types.html#nullable)\<`T`\>

Defined in: [src/types/ui.d.ts:37](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L37)

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`IUIElement`](./types.IUIElement.html) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

##### Returns

[`Nullable`](../modules/types.html#nullable)\<`T`\>

##### Inherited from

[`IUIInput`](./types.IUIInput.html).[`closest`](./types.IUIInput.html#closest)

#### Call Signature

**closest**\<`T`\>(`type`): [`Nullable`](../modules/types.html#nullable)\<`T`\>

Defined in: [src/types/ui.d.ts:38](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L38)

##### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`IUIElement`](./types.IUIElement.html) |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) \| `T` |

##### Returns

[`Nullable`](../modules/types.html#nullable)\<`T`\>

##### Inherited from

[`IUIInput`](./types.IUIInput.html).[`closest`](./types.IUIInput.html#closest)

***

### update()

**update**(): `void`

Defined in: [src/types/ui.d.ts:40](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L40)

#### Returns

`void`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`update`](./types.IUIInput.html#update)

***

### updateParentElement()

**updateParentElement**(`target`): `this`

Defined in: [src/types/ui.d.ts:41](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L41)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `target` | [`IUIElement`](./types.IUIElement.html) |

#### Returns

`this`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`updateParentElement`](./types.IUIInput.html#updateparentelement)

***

### appendTo()

**appendTo**(`element`): `this`

Defined in: [src/types/ui.d.ts:42](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L42)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `element` | [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement) |

#### Returns

`this`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`appendTo`](./types.IUIInput.html#appendto)

***

### validate()

**validate**(): `boolean`

Defined in: [src/types/ui.d.ts:155](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L155)

#### Returns

`boolean`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`validate`](./types.IUIInput.html#validate)

***

### focus()

**focus**(): `void`

Defined in: [src/types/ui.d.ts:156](https://github.com/xdan/jodit/blob/main/src/types/ui.d.ts#L156)

#### Returns

`void`

#### Inherited from

[`IUIInput`](./types.IUIInput.html).[`focus`](./types.IUIInput.html#focus)