UICheckbox | Jodit Editor - v4.0.0-beta.84

The base class of all Jodit UI components. Provides work with a life cycle.

Hierarchy

UIInput
- UICheckbox

Implements

IUICheckBox

Index

Constructors

constructor

new UICheckbox(jodit, options): UICheckbox
Parameters
- jodit: IViewBased<IViewOptions>
- options: Partial<{
      autocomplete: boolean;
      className: string;
      clearButton?: boolean;
      icon: string;
      label: string;
      name: string;
      onChange?: ((value) => void);
      placeholder: string;
      ref: string;
      required: boolean;
      type: "number" | "text" | "checkbox" | "url" | "file" | "hidden";
      validators: string[];
      value: string | number;
  } & {
      checked: boolean;
      switch: boolean;
  }>
Returns UICheckbox

Properties

`Static` STATUSES

STATUSES: {
    beforeDestruct: "beforeDestruct";
    beforeInit: "beforeInit";
    destructed: "destructed";
    ready: "ready";
} = STATUSES

Type declaration

Readonly beforeDestruct: "beforeDestruct"
Readonly beforeInit: "beforeInit"
Readonly destructed: "destructed"
Readonly ready: "ready"

async

async: IAsync = ...

container

container: HTMLElement

`Static` defaultState

defaultState: {
    autocomplete: boolean;
    className: string;
    clearButton?: boolean;
    icon: string;
    label: string;
    name: string;
    onChange?: ((value) => void);
    placeholder: string;
    ref: string;
    required: boolean;
    type: "number" | "text" | "checkbox" | "url" | "file" | "hidden";
    validators: string[];
    value: string | number;
} & {
    checked: boolean;
    switch: boolean;
} = ...

Type declaration

autocomplete: boolean
className: string
Optional clearButton?: boolean
icon: string
label: string
name: string
Optional onChange?: ((value) => void)
- - (value): void
  - Parameters
    - value: string
    Returns void
placeholder: string
ref: string
required: boolean
type: "number" | "text" | "checkbox" | "url" | "file" | "hidden"
validators: string[]
value: string | number

Type declaration

checked: boolean
switch: boolean

jodit

jodit: IViewBased<IViewOptions>

Parent View element

`Readonly` mods

mods: IDictionary<null | string | boolean> = {}

name

name: string = ''

nativeInput

nativeInput: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

state

state: {
    autocomplete: boolean;
    className: string;
    clearButton?: boolean;
    icon: string;
    label: string;
    name: string;
    onChange?: ((value) => void);
    placeholder: string;
    ref: string;
    required: boolean;
    type: "number" | "text" | "checkbox" | "url" | "file" | "hidden";
    validators: string[];
    value: string | number;
} & {
    checked: boolean;
    switch: boolean;
} = ...

Type declaration

autocomplete: boolean
className: string
Optional clearButton?: boolean
icon: string
label: string
name: string
Optional onChange?: ((value) => void)
- - (value): void
  - Parameters
    - value: string
    Returns void
placeholder: string
ref: string
required: boolean
type: "number" | "text" | "checkbox" | "url" | "file" | "hidden"
validators: string[]
value: string | number

Type declaration

checked: boolean
switch: boolean

`Readonly` uid

uid: string

Accessors

componentName

get componentName(): string
Returns string

componentStatus

get componentStatus(): ComponentStatus
Current component status

Returns ComponentStatus
set componentStatus(componentStatus): void
Setter for current component status
Parameters
- componentStatus: ComponentStatus
Returns void

defaultTimeout

get defaultTimeout(): number
Returns number

error

set error(value): void
Parameters
- value: string
Returns void

isDestructed

get isDestructed(): boolean
Component was destructed

Returns boolean

isFocused

get isFocused(): boolean
Returns boolean

isInDestruct

get isInDestruct(): boolean
The component is currently undergoing destructuring or has already been destroyed. Those. you should not hang new events on him now or do anything else with him.

Returns boolean

isReady

get isReady(): boolean
Component is ready for work

Returns boolean

j

get j(): T
Shortcut for this.jodit

Returns T

od

get od(): Document
Shortcut for this.ownerDocument

Returns Document

ow

get ow(): Window
Returns Window

ownerDocument

get ownerDocument(): Document
The document in which jodit was created

Returns Document

parentElement

get parentElement(): Nullable<IUIElement>
Returns Nullable<IUIElement>
set parentElement(parentElement): void
Parameters
- parentElement: Nullable<IUIElement>
Returns void

value

get value(): string
Returns string
set value(value): void
Parameters
- value: string
Returns void

Methods

afterSetMod

afterSetMod(name, value): void
Parameters
- name: string
- value: ModType
Returns void

appendTo

appendTo(element): UICheckbox
Append container to element
Parameters
- element: HTMLElement
Returns UICheckbox

bindDestruct

bindDestruct(component): UICheckbox
Bind destructor to some View
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns UICheckbox

bubble

bubble(callback): UICheckbox
Apply callback for all parents
Parameters
- callback: ((parent) => void)
  - - (parent): void
    - Parameters
      
      parent: IUIElement
      
      Returns void
Returns UICheckbox

className

className(): string
Returns string

closest

closest<T>(type): Nullable<T>
Find match parent
Type Parameters
- T extends IUIElement
Parameters
- type: Function | T
Returns Nullable<T>

`Static` closestElement

closestElement(node, type): Nullable<IUIElement>
Find closest UIElement in DOM
Parameters
- node: Node
- type: Function
Returns Nullable<IUIElement>

destruct

destruct(): any
Returns any

focus

focus(): void
Returns void

get

get<T>(chain, obj?): Nullable<T>
Type Parameters
- T
Parameters
- chain: string
- Optional obj: IDictionary
Returns Nullable<T>

getElm

getElm<T>(this, elementName): Nullable<HTMLElement>
Return element with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms<T>(this, elementName): HTMLElement[]
Return elements with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName): string
Calc BEM element class name
Parameters
- elementName: string
  
  element name in the bem classification
Returns string
getFullElName(elementName, mod): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName, mod, modValue): string
Parameters
- elementName: string
- mod: string
- modValue: string | boolean
Returns string

getMod

getMod(this, name): ModType
Get BEM class modification value
Parameters
- this: IMods
- name: string
Returns ModType

hookStatus

hookStatus(status, callback): void
Adds a handler for changing the component's status
Parameters
- status: ComponentStatus
  
  the status at which the callback is triggered
- callback: ((component) => void)
  
  a function that will be called when the status is status
  - - (component): void
    - Parameters
      
      component: UICheckbox
      
      Returns void
Returns void

i18n

i18n(text, ...params): string
Parameters
- text: string
- Rest ...params: (string | number)[]
Returns string

`Static` isInstanceOf

isInstanceOf<T>(c, constructorFunc): c is T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>>
Parameters
- c: unknown
- constructorFunc: Function
Returns c is T

setMod

setMod<T>(this, name, value, container?): T
Set/remove BEM class modification
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
  
  if null, mod will be removed
- Optional container: HTMLElement
Returns T

setParentView

setParentView(jodit): UICheckbox
Attach component to View
Parameters
- jodit: IViewBased<IViewOptions>
Returns UICheckbox

setStatus

setStatus(componentStatus): void
Set component status
Parameters
- componentStatus: ComponentStatus
  
  component status
Returns void

See
ComponentStatus

update

update(): void
Update UI from state

Returns void

updateParentElement

updateParentElement(target): UICheckbox
Parameters
- target: IUIElement
Returns UICheckbox

validate

validate(): boolean
Returns boolean

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

jodit: IViewBased<IViewOptions>

Returns UICheckbox

Properties

Static STATUSES

Type declaration

Readonly beforeDestruct: "beforeDestruct"

Readonly beforeInit: "beforeInit"

Readonly destructed: "destructed"

Readonly ready: "ready"

async

container

Static defaultState

Type declaration

autocomplete: boolean

className: string

Optional clearButton?: boolean

icon: string

label: string

name: string

Optional onChange?: ((value) => void)

Parameters

value: string

Returns void

placeholder: string

ref: string

required: boolean

type: "number" | "text" | "checkbox" | "url" | "file" | "hidden"

validators: string[]

value: string | number

Type declaration

checked: boolean

switch: boolean

jodit

Readonly mods

name

nativeInput

ownerWindow

state

Type declaration

autocomplete: boolean

className: string

Optional clearButton?: boolean

icon: string

label: string

name: string

Optional onChange?: ((value) => void)

Parameters

value: string

Returns void

placeholder: string

ref: string

required: boolean

type: "number" | "text" | "checkbox" | "url" | "file" | "hidden"

validators: string[]

value: string | number

Type declaration

checked: boolean

switch: boolean

Readonly uid

Accessors

componentName

Returns string

componentStatus

Returns ComponentStatus

Parameters

componentStatus: ComponentStatus

Returns void

defaultTimeout

Returns number

error

`Static` STATUSES

`Readonly` beforeDestruct: "beforeDestruct"

`Readonly` beforeInit: "beforeInit"

`Readonly` destructed: "destructed"

`Readonly` ready: "ready"

`Static` defaultState

`Optional` clearButton?: boolean

`Optional` onChange?: ((value) => void)

`Readonly` mods

`Optional` clearButton?: boolean

`Optional` onChange?: ((value) => void)

`Readonly` uid

`Static` closestElement