API reference for SfChipComponent

import {SfChipModule} from "@progress/sitefinity-component-framework";


selector: sf-chip

Implements

  • OnInit
  • OnChanges

Constructors

Properties

ariaActivedescendant: string

Sets aria-activedescendant attribute on the content of the chip

avatarClassList: string = ""

Class list for the element that is wrapping the avatar of the chip

avatarConfig: IChipAvatarConfig

The configuration needed for chip with avatar

chipContentClassList: string = ""

Class list for the chip's content

chipWrapperClassList: string = ""

Class list for the chip element

content: string

Sets the content of the chip element

contentLook: string

Sets the look of the chip's content

dropped: boolean

Enable dropped dropdown state

editable: boolean

Enable chip content editing

focusConfig: IChipTrackFocusConfig = ...

The configuration needed for the chip focus events

iconConfig: IChipIconConfig

The configuration needed for chip with icon

iconLook: string = "size-xs"

The look of the icon of the chip

iconWrapperClassList: string = ""

Class list for the element that is wrapping the icon of the chip

initials: string

Sets the initials shown as icon at the beginning of the chip

inputSubscription: Subject<KeyboardEvent> = ...
onArrowDown: EventEmitter<any> = ...

onArrowDown emitter Triggered when the arrow down key is pressed from editable chip

onArrowUp: EventEmitter<any> = ...

onArrowUp emitter Triggered when the arrow up key is pressed from editable chip

onEnter: EventEmitter<any> = ...

onEnterKey emitter Triggered when the enter key is pressed from editable chip

onEscape: EventEmitter<any> = ...

onEscape emitter Triggered when the escape key is pressed from editable chip

onFocusout: EventEmitter<any> = ...

onFocusout emitter Triggered when the focusout of the chip is fired

onInput: EventEmitter<any> = ...

onInput emitter Triggered when the input of the chip is fired

onRemove: EventEmitter<any> = ...

onRemove emitter Triggered when the remove button of the chip is clicked

removable: boolean

Enable the removing of the chip

title: string

Sets the attribute title of the chip element

wrapperLook: string

Sets the look of the chip element

Methods

  • Focus editable field of the chip

    Returns void

  • Handles chip content arrow down key pressed

    Parameters

    • event: KeyboardEvent

    Returns void

  • Handles chip content arrow up key pressed

    Parameters

    • event: KeyboardEvent

    Returns void

  • Handles chip content enter key pressed

    Parameters

    • event: KeyboardEvent

    Returns void

  • Handles chip content escape key pressed

    Parameters

    • event: KeyboardEvent

    Returns void

  • Handles focus out of the chip only when in editable mode

    Parameters

    • event: Event

    Returns void

  • Handles chip content editing

    Parameters

    • event: Event

    Returns void

  • Handles the remove chip button clicked

    Parameters

    • event: Event

    Returns void

  • Parameters

    • changes: SimpleChanges

    Returns void

  • Returns void

Generated using TypeDoc