SkawaNavItemComponent class

Component compositing SkawaSidebarItemComponent and MaterialButtonBase

A Toolbar item that is also a button. Only a small subset of Material Buttons features are exposed.

Most properties, events and attributes are the same as MaterialButtonComponent's. Please see it's documentation for general options.

Example usage:

Properties:

  • icon: String -- Icon name to display.

Events:

  • trigger: Event -- Published when the nav item is activated with click or keypress.

Attributes:

  • textOnly -- If present, icon will be ignored and it's place removed.
Inheritance
Mixed in types
Annotations
  • @Component(selector: 'skawa-nav-item', templateUrl: 'nav_item.html', styleUrls: ['nav_item.css'], directives: [SkawaSidebarItemComponent, MaterialRippleComponent, NgClass], changeDetection: ChangeDetectionStrategy.OnPush, providers: [Provider(ButtonDirective, useExisting: SkawaNavItemComponent)])

Constructors

SkawaNavItemComponent(HtmlElement element, ChangeDetectorRef _changeDetector, @Attribute('role') String role)

Properties

ariaRole String
read-onlyinherited
disabled bool
Is the component disabled.
read / writeinherited
disabledStr String
String value to be passed to aria-disabled.
read-onlyinherited
focused bool
Whether button is focused right now.
read-onlyinherited
fullWidth bool
read / write
hashCode int
The hash code for this object.
read-onlyinherited
hostTabIndex String
read-onlyinherited
hovering bool
read / write
icon String
MaterialIcon name to use as icon
read / write
isMouseDown bool
Whether the mouse is currently pressed on the button.
read-onlyinherited
isTextOnly bool
read-onlyinherited
ngClasses Map<String, bool>
read-only
raised bool
Is true if the button should have a box shadow that makes the button look raised.
read / writeinherited
role String
Role of this component used for a11y.
read / writeinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
tabbable bool
Is the component tabbable.
read / writeinherited
tabIndex String
read-onlyinherited
tabindex String
The tab index of the component.
write-onlyinherited
textOnly String
read / writeinherited
trigger Stream<UIEvent>
Fired when the button is activated via click, tap, or key press.
read-onlyinherited
visualFocus bool
Whether button appears focused right now.
read-onlyinherited
zElevation int
The elevation the material-shadow component should show.
read-onlyinherited

Methods

dispose() → void
Disposes this disposable and any resources it has open.
inherited
focus() → void
Item/component focuses itself
inherited
focusedStateChanged() → void
Overridable method for subclasses that implement push change detection.
override
handleClick(MouseEvent mouseEvent) → void
Triggers if not disabled.
inherited
handleKeyPress(KeyboardEvent keyboardEvent) → void
Triggers on enter and space if not disabled.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
onBlur(UIEvent event) → void
Triggered on blur.
inherited
onFocus(UIEvent event) → void
Triggered on focus.
inherited
onMouseDown(dynamic _) → void
Triggered on a mouse press.
inherited
onMouseEnter() → void
onMouseOut() → void
onMouseUp(dynamic _) → void
Triggered on a mouse release.
inherited
toString() String
A string representation of this object.
inherited
updateTabIndex() → void
Use this method if you want to manually compute and cache the tab index.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited