UISearch
- Hierarchy
- constructor
- STATUSES
- async
- uid
- ownerWindow
- jodit
- container
- name
- mods
- selInfo
- isOpened
- componentName
- ownerDocument
- od
- ow
- isReady
- isDestructed
- isInDestruct
- componentStatus
- j
- defaultTimeout
- parentElement
- currentIndex
- count
- query
- replace
- getFullElName
- bindDestruct
- setStatus
- hookStatus
- isInstanceOf
- i18n
- setParentView
- getElm
- getElms
- afterSetMod
- setMod
- getMod
- bubble
- updateParentElement
- get
- closest
- closestElement
- update
- appendTo
- destruct
- className
- render
- open
- close
plugins/search.UISearch
The base class of all Jodit UI components. Provides work with a life cycle.
Hierarchy
constructor
new UISearch(jodit): UISearch
Parameters
| Name | Type |
|---|---|
jodit |
IJodit |
Returns
Overrides
Defined in
src/plugins/search/ui/search.ts#87
STATUSES
Static STATUSES: Object = STATUSES
Type declaration
| Name | Type |
|---|---|
beforeInit |
"beforeInit" |
ready |
"ready" |
beforeDestruct |
"beforeDestruct" |
destructed |
"destructed" |
Inherited from
Defined in
src/core/component/component.ts#40
async
async: IAsync
Inherited from
Defined in
src/core/component/component.ts#44
uid
Readonly uid: string
Inherited from
Defined in
src/core/component/component.ts#59
ownerWindow
ownerWindow: Window = window
The window in which jodit was created
Inherited from
Defined in
src/core/component/component.ts#109
jodit
jodit: IJodit
Parent View element
Inherited from
Defined in
src/core/component/view-component.ts#22
container
container: HTMLElement
Inherited from
Defined in
name
name: string = ''
Inherited from
Defined in
mods
Readonly mods: IDictionary<null | string | boolean> = {}
Inherited from
Defined in
selInfo
selInfo: Nullable<MarkerInfo[]> = null
Defined in
src/plugins/search/ui/search.ts#29
isOpened
isOpened: boolean = false
Defined in
src/plugins/search/ui/search.ts#185
componentName
get componentName(): string
Returns
string
Inherited from
UIElement.componentName
Defined in
src/core/component/component.ts#46
ownerDocument
get ownerDocument(): Document
The document in which jodit was created
Returns
Inherited from
UIElement.ownerDocument
Defined in
src/core/component/component.ts#95
od
get od(): Document
Shortcut for this.ownerDocument
Returns
Inherited from
UIElement.od
Defined in
src/core/component/component.ts#102
ow
get ow(): Window
Returns
Inherited from
UIElement.ow
Defined in
src/core/component/component.ts#110
isReady
get isReady(): boolean
Component is ready for work
Returns
boolean
Inherited from
UIElement.isReady
Defined in
src/core/component/component.ts#145
isDestructed
get isDestructed(): boolean
Component was destructed
Returns
boolean
Inherited from
UIElement.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
UIElement.isInDestruct
Defined in
src/core/component/component.ts#160
componentStatus
get componentStatus(): ComponentStatus
Current component status
Returns
Inherited from
UIElement.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
UIElement.componentStatus
Defined in
src/core/component/component.ts#217
j
get j(): T
Shortcut for this.jodit
Returns
T
Inherited from
UIElement.j
Defined in
src/core/component/view-component.ts#27
defaultTimeout
get defaultTimeout(): number
Returns
number
Inherited from
UIElement.defaultTimeout
Defined in
src/core/component/view-component.ts#31
parentElement
get parentElement(): Nullable<IUIElement>
Returns
Inherited from
UIElement.parentElement
Defined in
set parentElement(parentElement): void
Parameters
| Name | Type |
|---|---|
parentElement |
Nullable<IUIElement> |
Returns
void
Inherited from
UIElement.parentElement
Defined in
currentIndex
get currentIndex(): number
Returns
number
Defined in
src/plugins/search/ui/search.ts#66
set currentIndex(value): void
Parameters
| Name | Type |
|---|---|
value |
number |
Returns
void
Defined in
src/plugins/search/ui/search.ts#70
count
set count(value): void
Parameters
| Name | Type |
|---|---|
value |
number |
Returns
void
Defined in
src/plugins/search/ui/search.ts#75
query
get query(): string
Returns
string
Defined in
src/plugins/search/ui/search.ts#79
replace
get replace(): string
Returns
string
Defined in
src/plugins/search/ui/search.ts#83
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
Defined in
src/core/component/component.ts#65
getFullElName(elementName, mod): string
Parameters
| Name | Type |
|---|---|
elementName |
string |
mod |
string |
Returns
string
Inherited from
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
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
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
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 |
Returns
void
Inherited from
Defined in
src/core/component/component.ts#265
isInstanceOf
isInstanceOf<T>(c, constructorFunc): c is T
Type parameters
| Name | Type |
|---|---|
T |
extends Component |
Parameters
| Name | Type |
|---|---|
c |
unknown |
constructorFunc |
Function |
Returns
c is T
Inherited from
Defined in
src/core/component/component.ts#283
i18n
i18n(text, ...params): string
Parameters
| Name | Type |
|---|---|
text |
string |
...params |
(string | number)[] |
Returns
string
Inherited from
Defined in
src/core/component/view-component.ts#35
setParentView
setParentView(jodit): this
Attach component to View
Parameters
| Name | Type |
|---|---|
jodit |
IJodit |
Returns
this
Inherited from
Defined in
src/core/component/view-component.ts#42
getElm
getElm<T>(this, elementName): Nullable<HTMLElement>
Return element with BEM class name
Type parameters
| Name | Type |
|---|---|
T |
extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms |
Parameters
| Name | Type |
|---|---|
this |
T |
elementName |
string |
Returns
Inherited from
Defined in
getElms
getElms<T>(this, elementName): HTMLElement[]
Return elements with BEM class name
Type parameters
| Name | Type |
|---|---|
T |
extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms |
Parameters
| Name | Type |
|---|---|
this |
T |
elementName |
string |
Returns
Inherited from
Defined in
afterSetMod
afterSetMod(name, value): void
Parameters
| Name | Type |
|---|---|
name |
string |
value |
ModType |
Returns
void
Inherited from
Defined in
setMod
setMod<T>(this, name, value, container?): T
Set/remove BEM class modification
Type parameters
| Name | Type |
|---|---|
T |
extends IComponent<IViewBased<IViewOptions>> & IContainer & IMods |
Parameters
| Name | Type | Description |
|---|---|---|
this |
T |
- |
name |
string |
- |
value |
ModType |
if null, mod will be removed |
container? |
HTMLElement |
- |
Returns
T
Inherited from
Defined in
getMod
getMod(this, name): ModType
Get BEM class modification value
Parameters
| Name | Type |
|---|---|
this |
IMods |
name |
string |
Returns
Inherited from
Defined in
bubble
bubble(callback): this
Apply callback for all parents
Parameters
| Name | Type |
|---|---|
callback |
(parent: IUIElement) => void |
Returns
this
Inherited from
Defined in
updateParentElement
updateParentElement(target): this
Parameters
| Name | Type |
|---|---|
target |
IUIElement |
Returns
this
Inherited from
Defined in
get
get<T>(chain, obj?): Nullable<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
chain |
string |
obj? |
IDictionary |
Returns
Nullable<T>
Inherited from
Defined in
closest
closest<T>(type): Nullable<T extends typeof UIElement ? InstanceType<T> : T>
Find match parent
Type parameters
| Name | Type |
|---|---|
T |
extends typeof UIElement | UIElement<IViewBased<IViewOptions>> |
Parameters
| Name | Type |
|---|---|
type |
Function | UIElement<IViewBased<IViewOptions>> |
Returns
Nullable<T extends typeof UIElement ? InstanceType<T> : T>
Inherited from
Defined in
closestElement
closestElement(node, type): Nullable<IUIElement>
Find closest UIElement in DOM
Parameters
| Name | Type |
|---|---|
node |
Node |
type |
Function |
Returns
Inherited from
Defined in
update
update(): void
Update UI from state
Returns
void
Inherited from
Defined in
appendTo
appendTo(element): this
Append container to element
Parameters
| Name | Type |
|---|---|
element |
HTMLElement |
Returns
this
Inherited from
Defined in
destruct
destruct(): any
Returns
any
Inherited from
Defined in
className
className(): string
Returns
string
Overrides
Defined in
src/plugins/search/ui/search.ts#23
render
render(): string
Returns
string
Overrides
UIElement.render
Defined in
src/plugins/search/ui/search.ts#36
open
open(query?, replace?, searchAndReplace?): void
Parameters
| Name | Type | Default value |
|---|---|---|
query? |
string |
undefined |
replace? |
string |
undefined |
searchAndReplace |
boolean |
false |
Returns
void
Defined in
src/plugins/search/ui/search.ts#188
close
close(): void
Returns
void
Defined in
jodit/src/plugins/search/ui/search.ts:228