Skip to content

.component()

esr360 edited this page Apr 18, 2019 · 11 revisions

Various Synergy Component operations

.component(name, operator)

.component(name, operator, config);
Param Type Info
name String The name of the component of interest
[operator] ('find'|'is'|'set'|'unset') The operation to apply to matched elements
[config] Object The configuration to use when calling the method (learn more)
  • If operator is not passed, it will assume to be find
  • If neither name nor operator are passed, the method will attempt to find all child components of each element in the set of matched elements

Operator - 'find'

Find all child components of each element in the set of matched elements filtered by the name parameter

Operator - 'is'

Determine if each element in the set of matched elements is the specified component

Operator - 'set'

Set each element in the set of matched elements as the specified Component

Operator - 'unset'

Unset each element in the set of matched elements as the specified Component

.component(name, callback)

.component(name, callback, config);
Param Type Info
name String The name of the component of interest
[callback] Function([HTMLElement] element) Function to call on matched components
[config] Object The configuration to use when calling the method (learn more)

Callback

A function to call on all child components filtered by the name parameter of each element in the set of matched elements, where element is the child component

Clone this wiki locally