MaterialSelectComponent<T> class
Material Select is a container for selecting items from a collection, marking selected options with a check icon.
Options can be specified manually (in your template), or via a SelectionOptions instance. Options can be marked as selected via template or by checking against a selection model.
- Inheritance
-
- Object
- SelectionContainer<
T> - MaterialSelectBase<
T> - MaterialSelectComponent
- Implemented types
- Annotations
-
- @Component(selector: 'material-select', providers: [ExistingProvider(HasDisabled, MaterialSelectComponent), ExistingProvider(HasRenderer, MaterialSelectComponent), ExistingProvider(SelectionContainer, MaterialSelectComponent)], directives: [FocusItemDirective, FocusListDirective, MaterialListComponent, MaterialSelectItemComponent, NgIf, NgFor], directiveTypes: [Typed<MaterialSelectItemComponent>.of([#T])], templateUrl: 'material_select.html', styleUrls: ['material_select.scss.css'])
Constructors
Properties
- ariaDescribedBy ↔ String?
-
The description which will be set to select groups' aria-describedby.
getter/setter pair
- ariaLabelledBy ↔ String?
-
The label which will be set to select group's aria-labelledby.
getter/setter pair
- autoFocusIndex → int?
-
no setter
- disabled ↔ bool
-
Whether the select should be shown as disabled.
getter/setter pairoverride
- disabledStr → String
-
no setter
-
factoryRenderer
↔ FactoryRenderer<
RendersValue, T> ? -
Specifies the componentRenderer to use to determine the component for
rendering an item.
Specifies the factoryRenderer to use to determine the factory for
rendering an item.
getter/setter pairinherited-getteroverride-setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isMultiSelect → bool
-
no setteroverride
- isMultiSelectStr → String
-
no setter
- isSingleSelect → bool
-
no setterinherited
-
itemRenderer
↔ ItemRenderer<
T> ? -
A simple function to render the an item to string.
@override
getter/setter pairoverride
- listAutoFocus ← bool
-
Whether to auto-focus the list as soon as it appears.
no getter
-
options
↔ SelectionOptions<
T> -
The available options for this container.
getter/setter pairinherited-getteroverride-setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selection
↔ SelectionModel<
T> -
The selection model this container represents.
getter/setter pairoverride
-
selectItems
← List<
SelectionItem< T> > -
no getter
- trackByIndexFn → TrackFunction
-
Function for use by NgFor for optionGroup to avoid recreating the
DOM for the optionGroup.
final
- width ↔ int
-
Preset width, 1 through 5. By default, width #0 is used.
Each width multiplies the base block width (64px on desktop and tablet) by
1.5, 3, 5, 6, 7, respectively to obtain a predictable width. Set to 0 to have the list expand to fit its content. Note: The spec clearly lays out predefined list sizes so use the default, expanding size, sparingly.getter/setter pairinherited-getteroverride-setter
Methods
-
isOptionDisabled(
T item) → bool - If selectionOptions implements Selectable, it is called to decided whether an item is disabled.
-
ngOnInit(
) → void - Executed after the first change detection run for a directive.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited