UIButtonGroup

Hierarchy

ui/button.UIButtonGroup

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

Hierarchy

UIGroup

↳ UIButtonGroup

constructor

new UIButtonGroup(jodit, options?): UIButtonGroup

Parameters

Name	Type
`jodit`	`IViewBased`<`IViewOptions`>
`options`	`Object`
`options.name?`	`string`
`options.value?`	`string` \| `number` \| `boolean`
`options.label?`	`string`
`options.onChange?`	(`values`: `IUIOption`[]) => `void`
`options.options?`	`IUIOption`[]
`options.radio`	`boolean`

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

Name	Type
`beforeInit`	`"beforeInit"`
`ready`	`"ready"`
`beforeDestruct`	`"beforeDestruct"`
`destructed`	`"destructed"`

Inherited from

UIGroup.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Inherited from

UIGroup.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Inherited from

UIGroup.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Inherited from

UIGroup.ownerWindow

Defined in

src/core/component/component.ts#109

jodit

jodit: IViewBased<IViewOptions>

Parent View element

Inherited from

UIGroup.jodit

Defined in

src/core/component/view-component.ts#22

elements

elements: IUIButton[]

Overrides

UIGroup.elements

Defined in

src/core/ui/button/group/group.ts#26

options

Readonly options: Object

Type declaration

Name	Type
`name?`	`string`
`value?`	`string` \| `number` \| `boolean`
`label?`	`string`
`onChange?`	(`values`: `IUIOption`[]) => `void`
`options?`	`IUIOption`[]
`radio`	`boolean`

Inherited from

UIGroup.options

Defined in

src/core/ui/button/group/group.ts#52

container

container: HTMLElement

Inherited from

UIGroup.container

Defined in

src/core/ui/element.ts#32

name

name: string = ''

Inherited from

UIGroup.name

Defined in

src/core/ui/element.ts#33

mods

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

Inherited from

UIGroup.mods

Defined in

src/core/ui/element.ts#119

syncMod

syncMod: boolean = false

Synchronize mods to all children

Inherited from

UIGroup.syncMod

Defined in

src/core/ui/group/group.ts#42

buttonSize

buttonSize: "small" | "tiny" | "xsmall" | "middle" | "large" = 'middle'

Inherited from

UIGroup.buttonSize

Defined in

src/core/ui/group/group.ts#71

componentName

get componentName(): string

Returns

string

Inherited from

UIGroup.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Inherited from

UIGroup.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Inherited from

UIGroup.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Inherited from

UIGroup.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Inherited from

UIGroup.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Inherited from

UIGroup.isDestructed

Defined in

src/core/component/component.ts#152

isInDestruct

get isInDestruct(): boolean

The component is currently undergoing destructuring or has already been destroyed.
Those. you should not the app froze new events on him now or do anything else with him.

Returns

boolean

Inherited from

UIGroup.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Inherited from

UIGroup.componentStatus

Defined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name	Type
`componentStatus`	`ComponentStatus`

Returns

void

Inherited from

UIGroup.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Inherited from

UIGroup.j

Defined in

src/core/component/view-component.ts#27

defaultTimeout

get defaultTimeout(): number

Returns

number

Inherited from

UIGroup.defaultTimeout

Defined in

src/core/component/view-component.ts#31

parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Inherited from

UIGroup.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name	Type
`parentElement`	`Nullable`<`IUIElement`>

Returns

void

Inherited from

UIGroup.parentElement

Defined in

src/core/ui/element.ts#41

allChildren

get allChildren(): IUIElement[]

All group children

Returns

IUIElement[]

Inherited from

UIGroup.allChildren

Defined in

src/core/ui/group/group.ts#49

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name	Type	Description
`elementName`	`string`	element name in the bem classification

Returns

string

Inherited from

UIGroup.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name	Type
`elementName`	`string`
`mod`	`string`

Returns

string

Inherited from

UIGroup.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

Parameters

Name	Type
`elementName`	`string`
`mod`	`string`
`modValue`	`string` \| `boolean`

Returns

string

Inherited from

UIGroup.getFullElName

Defined in

src/core/component/component.ts#67

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name	Type
`component`	`IComponent`<`IViewBased`<`IViewOptions`>>

Returns

this

Inherited from

UIGroup.bindDestruct

Defined in

src/core/component/component.ts#170

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name	Type	Description
`componentStatus`	`ComponentStatus`	component status

Returns

void

See

ComponentStatus

Inherited from

UIGroup.setStatus

Defined in

src/core/component/component.ts#226

hookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

Parameters

Name	Type	Description
`status`	`ComponentStatus`	the status at which the callback is triggered
`callback`	(`component`: `this`) => `void`	a function that will be called when the status is `status`