UIButtonGroup | Jodit Editor

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

Hierarchy

UIGroup
- UIButtonGroup

Index

Constructors

constructor

new UIButtonGroup(jodit, options?): UIButtonGroup
Parameters
- jodit: IViewBased<IViewOptions>
- options: {
      label?: string;
      name?: string;
      onChange?: ((values) => void);
      options?: IUIOption[];
      radio: boolean;
      value?: string | number | boolean;
  } = ...
  - Optional label?: string
  - Optional name?: string
  - Optional onChange?: ((values) => void)
    - (values): void
      
      Parameters
      
      values: IUIOption[]
      
      Returns void
  - Optional options?: IUIOption[]
  - radio: boolean
  - Optional value?: string | number | boolean
Returns UIButtonGroup

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 = ...

buttonSize

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

container

container: HTMLElement

elements

elements: IUIButton[]

jodit

jodit: IViewBased<IViewOptions>

Parent View element

`Readonly` mods

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

name

name: string = ''

`Readonly` options

options: {
    label?: string;
    name?: string;
    onChange?: ((values) => void);
    options?: IUIOption[];
    radio: boolean;
    value?: string | number | boolean;
} = ...

Type declaration

Optional label?: string
Optional name?: string
Optional onChange?: ((values) => void)
- - (values): void
  - Parameters
    - values: IUIOption[]
    Returns void
Optional options?: IUIOption[]
radio: boolean
Optional value?: string | number | boolean

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

syncMod

syncMod: boolean = false

Synchronize mods to all children

`Readonly` uid

uid: string

Accessors

allChildren

get allChildren(): IUIElement[]
All group children

Returns IUIElement[]

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

isDestructed

get isDestructed(): boolean
Component was destructed

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

Methods

afterSetMod

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

append

append(elm, distElement?): UIButtonGroup
Append new element into group
Parameters
- elm: IUIElement | IUIElement[]
- Optional distElement: string
Returns UIButtonGroup

appendTo

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

bindDestruct

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

bubble

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

className

className(): string
Returns string

clear

clear(): UIButtonGroup
Clear group

Returns UIButtonGroup

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

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: UIButtonGroup
      
      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

remove

remove(elm): UIButtonGroup
Remove element from group
Parameters
- elm: IUIElement
Returns UIButtonGroup

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): UIButtonGroup
Attach component to View
Parameters
- jodit: IViewBased<IViewOptions>
Returns UIButtonGroup

setStatus

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

See
ComponentStatus

update

update(): void
Update all children

Returns void

updateParentElement

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

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

jodit: IViewBased<IViewOptions>

options: { label?: string; name?: string; onChange?: ((values) => void); options?: IUIOption[]; radio: boolean; value?: string | number | boolean; } = ...

Optional label?: string

Optional name?: string

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

Parameters

values: IUIOption[]

Returns void

Optional options?: IUIOption[]

radio: boolean

Optional value?: string | number | boolean

Returns UIButtonGroup

Properties

Static STATUSES

Type declaration

Readonly beforeDestruct: "beforeDestruct"

Readonly beforeInit: "beforeInit"

Readonly destructed: "destructed"

Readonly ready: "ready"

async

buttonSize

container

elements

jodit

Readonly mods

name

Readonly options

Type declaration

Optional label?: string

Optional name?: string

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

Parameters

values: IUIOption[]

Returns void

Optional options?: IUIOption[]

radio: boolean

Optional value?: string | number | boolean

ownerWindow

syncMod

Readonly uid

Accessors

allChildren

Returns IUIElement[]

componentName

Returns string

componentStatus

Returns ComponentStatus

Parameters

componentStatus: ComponentStatus

Returns void

defaultTimeout

Returns number

isDestructed

Returns boolean

isInDestruct

Returns boolean

isReady

Returns boolean

j

Returns T

od

Returns Document

ow

Returns Window

ownerDocument

Returns Document

parentElement

Returns Nullable<IUIElement>

Parameters

parentElement: Nullable<IUIElement>

Returns void

options: {
label?: string;
name?: string;
onChange?: ((values) => void);
options?: IUIOption[];
radio: boolean;
value?: string | number | boolean;
} = ...

`Optional` label?: string

`Optional` name?: string

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

`Optional` options?: IUIOption[]

`Optional` value?: string | number | boolean

`Static` STATUSES

`Readonly` beforeDestruct: "beforeDestruct"

`Readonly` beforeInit: "beforeInit"

`Readonly` destructed: "destructed"

`Readonly` ready: "ready"

`Readonly` mods

`Readonly` options

`Optional` label?: string

`Optional` name?: string

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

`Optional` options?: IUIOption[]

`Optional` value?: string | number | boolean

`Readonly` uid

`Optional` distElement: string

`Static` closestElement

`Optional` obj: IDictionary