---
title: "IViewBased"
---
# IViewBased

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

## Extends

- [`IContainer`](./types.IContainer.html).[`IComponent`](./types.IComponent.html).[`IMods`](./types.IMods.html).[`IElms`](./types.IElms.html)

## Extended by

- [`IDialog`](./types.IDialog.html)
- [`IViewWithToolbar`](./types.IViewWithToolbar.html)

## Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `T` | [`IViewOptions`](./types.IViewOptions.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

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

***

### container

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

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

#### Inherited from

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

***

### 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

[`IComponent`](./types.IComponent.html).[`async`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`ownerDocument`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`od`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`ownerWindow`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`ow`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`componentName`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`uid`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`isDestructed`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`isInDestruct`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`isReady`](./types.IComponent.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

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

***

### isView

`readonly` **isView**: `true`

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

***

### parent

`readonly` **parent**: [`Nullable`](../modules/types.html#nullable)\<`IViewBased`\<[`IViewOptions`](./types.IViewOptions.html)\>\>

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

***

### id

`readonly` **id**: `string`

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

ID attribute for a source element, id add {id}_editor it's editor's id

***

### basePath

`readonly` **basePath**: `string`

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

***

### minified

`readonly` **minified**: `boolean`

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

***

### isLocked

`readonly` **isLocked**: `boolean`

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

***

### isFullSize

`readonly` **isFullSize**: `boolean`

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

***

### buffer

`readonly` **buffer**: [`IStorage`](./types.IStorage.html)

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

***

### ~~storage~~

`readonly` **storage**: [`IStorage`](./types.IStorage.html)

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

#### Deprecated

Use asyncStorage instead

***

### asyncStorage

`readonly` **asyncStorage**: [`IAsyncStorage`](./types.IAsyncStorage.html)

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

***

### progressbar

`readonly` **progressbar**: [`IProgressBar`](./types.IProgressBar.html)

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

***

### events

`readonly` **events**: [`IEventEmitter`](./types.IEventEmitter.html)

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

***

### e

`readonly` **e**: [`IEventEmitter`](./types.IEventEmitter.html)

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

***

### create

`readonly` **create**: [`ICreate`](./types.ICreate.html)

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

***

### c

`readonly` **c**: [`ICreate`](./types.ICreate.html)

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

***

### OPTIONS

`readonly` **OPTIONS**: `T`

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

***

### options

`readonly` **options**: `T`

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

***

### o

`readonly` **o**: `T`

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

***

### defaultTimeout

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

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

***

### components

`readonly` **components**: [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)\<[`IComponent`](./types.IComponent.html)\<`IViewBased`\<[`IViewOptions`](./types.IViewOptions.html)\>\>\>

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

***

### message

`readonly` **message**: [`IMessages`](./types.IMessages.html)

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

### 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`\<[`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

[`IMods`](./types.IMods.html).[`setMod`](./types.IMods.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

[`IMods`](./types.IMods.html).[`afterSetMod`](./types.IMods.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

[`IMods`](./types.IMods.html).[`getMod`](./types.IMods.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

[`IElms`](./types.IElms.html).[`getElm`](./types.IElms.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

[`IElms`](./types.IElms.html).[`getElms`](./types.IElms.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`\<[`IViewOptions`](./types.IViewOptions.html)\> |

#### Returns

`any`

#### Inherited from

[`IComponent`](./types.IComponent.html).[`destruct`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`get`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`className`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`getFullElName`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`getFullElName`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`getFullElName`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`setStatus`](./types.IComponent.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

[`IComponent`](./types.IComponent.html).[`hookStatus`](./types.IComponent.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

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

***

### isLockedNotBy()

**isLockedNotBy**(`name`): `boolean`

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

#### Parameters

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

#### Returns

`boolean`

***

### lock()

**lock**(`name?`): `boolean`

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

#### Parameters

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

#### Returns

`boolean`

***

### unlock()

**unlock**(): `boolean`

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

#### Returns

`boolean`

***

### toggleFullSize()

**toggleFullSize**(`isFullSize?`): `void`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `isFullSize?` | `boolean` |

#### Returns

`void`

***

### i18n()

**i18n**(`text`, ...`params`): `string`

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

#### Parameters

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

#### Returns

`string`

***

### getVersion()

**getVersion**(): `string`

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

#### Returns

`string`

***

#### Call Signature

**getInstance**\<`T`\>(`module`, `options?`): `T`

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

##### Type Parameters

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

##### Parameters

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

##### Returns

`T`

#### Call Signature

**getInstance**\<`T`\>(`moduleName`, `options?`): `T`

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

##### Type Parameters

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

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `moduleName` | `string` |
| `options?` | `object` |

##### Returns

`T`