### File

`src/dropdown/abstract-dropdown-view.class.ts`

### Description

A component that intends to be used within `Dropdown` must provide an implementation that extends this base class. It also must provide the base class in the `@Component` meta-data. ex: `providers: [{provide: AbstractDropdownView, useExisting: forwardRef(() => MyDropdownView)}]`

### Index

###### Properties
Public size Public type
###### Methods
filterBy getCurrentElement getCurrentItem getListItems getNextElement getNextItem getPrevElement getPrevItem getSelected hasNextElement hasPrevElement initFocus propagateSelected
###### Inputs
items
###### Outputs
blurIntent select
###### Accessors
items

### Properties

Public size
`size: `"sm" | "md" | "lg"``
Type : `"sm" | "md" | "lg"`
Default value : `"md"`
Defined in src/dropdown/abstract-dropdown-view.class.ts:43
Specifies the render size of the items within the `AbstractDropdownView`.

Public type
`type: `"single" | "multi"``
Type : `"single" | "multi"`
Default value : `"single"`
Defined in src/dropdown/abstract-dropdown-view.class.ts:39
Specifies whether or not the `DropdownList` supports selecting multiple items as opposed to single item selection.

### Methods

filterBy
`filterBy(value: string)`
Defined in src/dropdown/abstract-dropdown-view.class.ts:92
Parameters :
Name | Type | Optional | Description
value | `string` | No | `value to filter the list by`
Returns : `void`

getCurrentElement
`getCurrentElement()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:79
Returns the `HTMLElement` for the item that is selected within the `DropdownList`. Returns : `HTMLElement`

getCurrentItem
`getCurrentItem()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:75
Returns the `ListItem` that is selected within `DropdownList`. Returns : `ListItem`

getListItems
`getListItems()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:83
Guaranteed to return the current items as an Array. Returns : `Array<ListItem>`

getNextElement
`getNextElement()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:55
Returns the `HTMLElement` for the item that is subsequent to the selected item. Returns : `HTMLElement`

getNextItem
`getNextItem()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:47
Returns the `ListItem` that is subsequent to the selected item in the `DropdownList`. Returns : `ListItem`

getPrevElement
`getPrevElement()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:67
Returns the `HTMLElement` for the item that precedes the selected item. Returns : `HTMLElement`

getPrevItem
`getPrevItem()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:59
Returns the `ListItem` that precedes the selected item within `DropdownList`. Returns : `ListItem`

getSelected
`getSelected()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:71
Returns the selected leaf level item(s) within the `DropdownList`. Returns : `ListItem[]`

hasNextElement
`hasNextElement()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:51
Returns a boolean if the currently selected item is preceded by another Returns : `boolean`

hasPrevElement
`hasPrevElement()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:63
Returns a boolean if the currently selected item is followed by another Returns : `boolean`

initFocus
`initFocus()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:97
Initializes focus in the list In most cases this just calls `getCurrentElement().focus()` Returns : `void`

propagateSelected
`propagateSelected(value: Array)`
Defined in src/dropdown/abstract-dropdown-view.class.ts:87
Transforms array input list of items to the correct state by updating the selected item(s). Parameters :
Name | Type | Optional
value | `Array<ListItem>` | No
Returns : `void`

### Inputs

`items` | The items to be displayed in the list within the `AbstractDropDownView`.
Defined in src/dropdown/abstract-dropdown-view.class.ts:15

### Outputs

`blurIntent` | Event to suggest a blur on the view. Emits after the first/last item has been focused. ex. ArrowUp -> focus first item ArrowUp -> emit event It's recommended that the implementing view include a specific type union of possible blurs ex. `@Output() blurIntent = new EventEmitter<"top" | "bottom">();` `$event` Type: `EventEmitter<any>`
Defined in src/dropdown/abstract-dropdown-view.class.ts:34

`select` | Emits selection events to controlling classes Deprecated: `Object` as a valid type. `$event` Type: `EventEmitter<literal type | [] | Object>`
Defined in src/dropdown/abstract-dropdown-view.class.ts:23

### Accessors

items
get `items()`
Defined in src/dropdown/abstract-dropdown-view.class.ts:17
set `items(value)`
Defined in src/dropdown/abstract-dropdown-view.class.ts:15
The items to be displayed in the list within the `AbstractDropDownView`. Parameters :
Name | Optional
value | No
Returns : `void`

    import { Input, Output, EventEmitter } from "@angular/core";
    import { ListItem } from "./list-item.interface";
    import { Observable } from "rxjs";

    /**
     * A component that intends to be used within `Dropdown` must provide an implementation that extends this base class.
     * It also must provide the base class in the `@Component` meta-data.
     * ex: `providers: [{provide: AbstractDropdownView, useExisting: forwardRef(() => MyDropdownView)}]`
     */
    export class AbstractDropdownView {
    	/**
    	 * The items to be displayed in the list within the `AbstractDropDownView`.
    	 */
    	@Input() set items(value: Array<ListItem> | Observable<Array<ListItem>>) { }

    	get items(): Array<ListItem> | Observable<Array<ListItem>> { return; }
    	/**
    	 * Emits selection events to controlling classes
    	 *
    	 * Deprecated: `Object` as a valid type.
    	 */
    	@Output() select: EventEmitter<{item: ListItem } | ListItem[] | Object>;
    	/**
    	 * Event to suggest a blur on the view.
    	 * Emits _after_ the first/last item has been focused.
    	 * ex.
    	 * ArrowUp -> focus first item
    	 * ArrowUp -> emit event
    	 *
    	 * It's recommended that the implementing view include a specific type union of possible blurs
    	 * ex. `@Output() blurIntent = new EventEmitter<"top" | "bottom">();`
    	 */
    	@Output() blurIntent: EventEmitter<any>;
    	/**
    	 * Specifies whether or not the `DropdownList` supports selecting multiple items as opposed to single
    	 * item selection.
    	 */
    	public type: "single" | "multi" = "single";
    	/**
    	 * Specifies the render size of the items within the `AbstractDropdownView`.
    	 */
    	public size: "sm" | "md" | "lg" = "md";
    	/**
    	 * Returns the `ListItem` that is subsequent to the selected item in the `DropdownList`.
    	 */
    	getNextItem(): ListItem { return; }
    	/**
    	 * Returns a boolean if the currently selected item is preceded by another
    	 */
    	hasNextElement(): boolean { return; }
    	/**
    	 * Returns the `HTMLElement` for the item that is subsequent to the selected item.
    	 */
    	getNextElement(): HTMLElement { return; }
    	/**
    	 * Returns the `ListItem` that precedes the selected item within `DropdownList`.
    	 */
    	getPrevItem(): ListItem { return; }
    	/**
    	 * Returns a boolean if the currently selected item is followed by another
    	 */
    	hasPrevElement(): boolean { return; }
    	/**
    	 * Returns the `HTMLElement` for the item that precedes the selected item.
    	 */
    	getPrevElement(): HTMLElement { return; }
    	/**
    	 * Returns the selected leaf level item(s) within the `DropdownList`.
    	 */
    	getSelected(): ListItem[] { return; }
    	/**
    	 * Returns the `ListItem` that is selected within `DropdownList`.
    	 */
    	getCurrentItem(): ListItem { return; }
    	/**
    	 * Returns the `HTMLElement` for the item that is selected within the `DropdownList`.
    	 */
    	getCurrentElement(): HTMLElement { return; }
    	/**
    	 * Guaranteed to return the current items as an Array.
    	 */
    	getListItems(): Array<ListItem> { return; }
    	/**
    	 * Transforms array input list of items to the correct state by updating the selected item(s).
    	 */
    	propagateSelected(value: Array<ListItem>): void {}
    	/**
    	 *
    	 * @param value value to filter the list by
    	 */
    	filterBy(value: string): void {}
    	/**
    	 * Initializes focus in the list
    	 * In most cases this just calls `getCurrentElement().focus()`
    	 */
    	initFocus(): void {}
    }

# result-matching ""

# No results matching ""