packages/ecl/components/ecl-inpage-navigation/ecl-inpage-navigation-item.component.ts
Represent a single navigation item. contains the link, that activates/scrolls to the new current paragraph of the page.
| selector | li[eclInpageNavigationItem] |
| imports |
EUI_ECL_LINK
|
| styles |
:host {
display: list-item;
}
|
| templateUrl | ./ecl-inpage-navigation-item.component.html |
Properties |
Methods |
Inputs |
Outputs |
HostBindings |
Accessors |
constructor()
|
| isActive |
Type : boolean
|
| label |
Type : string
|
|
The label that is displayed in the items list. |
| sectionId |
Type : string
|
| class |
Type : string
|
| e2eAttr |
Type : any
|
| tabindex |
Type : number
|
| itemArrowDown |
Type : EventEmitter
|
|
Emitted when on keyboard navigation, user clicks the arrow-down. |
| itemArrowUp |
Type : EventEmitter
|
|
Emitted when on keyboard navigation, user clicks the arrow-up. |
| itemClick |
Type : EventEmitter
|
|
Emited when user clicks on the item. |
| itemEnter |
Type : EventEmitter
|
|
Emitted when on keyboard navigation, user clicks the ENTER. |
| itemTab |
Type : EventEmitter
|
|
Emitted when on keyboard navigation, user clicks the TAB. |
| attr.role |
Type : string
|
Default value : 'listitem'
|
|
The role of the component is 'listitem', should not be changed. |
| class.ecl-inpage-navigation__item |
Type : boolean
|
Default value : true
|
| onArrowDown | ||||||
onArrowDown(evt: Event)
|
||||||
|
Parameters :
Returns :
void
|
| onArrowUp | ||||||
onArrowUp(evt: Event)
|
||||||
|
Parameters :
Returns :
void
|
| onEnter | ||||||
onEnter(evt: Event)
|
||||||
|
Parameters :
Returns :
void
|
| onFocus |
onFocus()
|
|
Returns :
void
|
| onItemClick | ||||||
onItemClick(evt: MouseEvent)
|
||||||
|
Parameters :
Returns :
void
|
| onTab | ||||||
onTab(evt: Event)
|
||||||
|
Parameters :
Returns :
void
|
| getCssClasses | ||||||
getCssClasses(rootClass: string)
|
||||||
|
Parameters :
Returns :
string
|
| cmpClass |
Type : unknown
|
Default value : true
|
Decorators :
@HostBinding('class.ecl-inpage-navigation__item')
|
| link |
Type : EclLinkDirective
|
Decorators :
@ViewChild(EclLinkDirective)
|
| role |
Type : string
|
Default value : 'listitem'
|
Decorators :
@HostBinding('attr.role')
|
|
The role of the component is 'listitem', should not be changed. |
| sectionElement |
getsectionElement()
|
|
Returns page element/paragraph, that is associated with this item from the navigation list.
Returns :
HTMLElement | null
|