angular_components library

Classes

ActivateItemOnKeyPressMixin<T>
ActivationHandler<T>
AcxDarkTheme
Applies the dark theme class to an element, iff the dark theme is active.
AfterCustomAlignment
Alignment
Enum for browser display alignment options.
AsyncUpdateScheduler
An utility class for notifying ~once per VM turn to do an update action.
AutoDismissDirective
A directive that publishes a (dismiss) event when a focus, click or mouseup event occurs outside of it.
AutoFocusDirective
The element will be focused as soon as directive is initialized.
BaseDropdownSelectValueAccessor<T>
Base ControlValueAccessor for material dropdown select for common logic between single, and multiple selection dropdowns.
BaseMaterialInput
Base class for behavior that is shared between material input components.
BaseMaterialInputValueAccessor<T>
Common logic for a ControlValueAccessor for a BaseMaterialInputComponent.
BaseMaterialNumberValueAccessor<T>
Base accessor to handle various numerical types with MaterialInput.
BaseSingleLineInputComponent
Base single line component.
BeforeCustomAlignment
BoundaryAwareKeyDirective
Base implementation of directive to listen to key events.
ButtonDirective
ButtonDirective adds all basic required a11y functional for any element, that are designed to work as a button (clickable icon, etc.)
CachingDeferredContentDirective
Nested inside a DeferredContentAware container, this directive creates its content the first time the parent container becomes visible.
CalendarDay
A calendar day.
CalendarMonth
A calendar month; the basic unit of the scrolling calendar. It has a localized title ("Mar 2015") and a collection of weeks.
CalendarSelection
A selected range on the calendar.
CalendarState
The (immutable) state of selections on the calendar.
CalendarWeek
A calendar week.
CalendarYear
A calendar year; the basic unit of the scrolling month grid. It has a localized title ("2015") and a collection of months.
CastIterable<T>
A mixin that provides the implementation of castIterable.
CheckIntegerValidator
Validator which will validate a number input is an integer.
CheckNonNegativeValidator
Validator which will validate a number input is not negative, >= 0
ClickableTooltipTargetDirective
A directive that marks the target of a tooltip and handles activating on mouse over (with delay), click, enter, and space.
DarkThemeDirective
Sets the dark theme value for a subtree.
Date
A calendar date. Year / month / day.
DateInputDirective
A decorator which makes the decorated input automatically parse localized dates.
DatepickerComparison
An implementation of DateRangeComparison that has DatepickerDateRanges instead of plain DateRanges.
DatepickerDateRange
A datepicker-specific implementation of DateRange, extended with a title and an interface for computing the next/previous date range.
DatepickerModel
Represents the full state of externally-visible stuff selected by the material date range picker component. This is mostly here to make dependency injection easier.
DatepickerPreset
A DatepickerPreset represents an option for selecting a predefined date range in material-date-range-picker.
DatepickerSelection
Represents something that might be chosen by some hypothetical date picker component.
DateRange
A date range with a start and end, inclusive. null values for either means the range is unbounded in that direction.
DateRangeChange
Bundles up the currently-selected date range, along with the kind of user interaction that caused the change. E.g. we might (and do) want to ignore all dates selected via drag.
DateRangeComparison
A date range and an optional comparison date range.
DateRangeEditorComponent
Everything needed to edit a DateRangeComparison. Glues together the preset list, the text boxes, the next/prev, and the calendar. This is meant to be used in the material-date-range-picker, and doesn't make much sense outside of that component.
DateRangeEditorModel
Models the datepicker state.
DateRangeEditorNextPrevModel
DateRangeInputComponent
A date-range-input is two date inputs glued together.
DecimalNumberFormatDirective
Helper directive to provide a basic NumberFormat pattern for use with number accessors.
DeferredContentAware
A container which controls the visibility of its content via a Stream.
DeferredContentDirective
When put on an element B, this directive creates B each time the nearest strict ancestor DeferredContentAware container A becomes visible and destroys B each time A becomes invisible.
DeferredValidator
A validator that defers to another delegator.
DelegatingMultiSelectionModel<T>
A delegating implementation of MultiSelectionModel.
DelegatingSelectionModel<T>
A delegating implementation of SelectionModel.
DelegatingSelectionOptions<T>
A SelectionOptions implementation that delegates.
DelegatingSingleSelectionModel<T>
A delegating implementation of SingleSelectionModel.
DisplayNameRendererDirective<T>
Add this directive to any SelectionContainer or SelectionItem component to render HasUIDisplayName objects.
DisposableFuture<T>
A future that is disposable, which cancels the underlying operation, if any. Even if the operation finishes, then will not be fired if dispose is called first.
DomPopupSource
An implementation of PopupSource that lives on the UI layer.
DomPopupSourceFactory
A factory that can createPopupSource from HTML elements.
A button styled specifically for dropdowns.
A simple handle for Dropdown components. Components wishing to control an ancestral dropdown can have this interface injected: @Optional() DropdownHandle dropdown
The DropdownMenuComponent combines a DropdownButtonComponent with a MenuPopup.
ControlValueAccessor for material dropdown select which only allows a single selection allowing integration with the angular forms API.
DynamicComponent
Dynamically renders another component, setting the value field on the dynamic component if it implements RendersValue (and not if the component does not implement the interface).
ElementPopupSource
An PopupSource that's based on an element.
ElementStyleEnum
EmptySimpleStream<T>
An Empty stream that does not support any listeners but pretends to be listening.
EnterAcceptsDirective
If attached to yes-no buttons, it will listen for Enter keyup events and trigger the yes action on them.
EscapeCancelsDirective
If attached to the yes-no buttons it will listen for escape keyup event and trigger no action on it.
ExpandAction
Represents an intent to open the menu popup.
Filterable
Interface for applying a Filter.
FixedMaterialTabStripComponent
A tab strip component with Tab-styled buttons and active tab indicator.
FixedPopupSizeProvider
Provides a popup size with a fixed maximum width and height in pixels.
Focusable
A component or directive that can be programmatically focused.
FocusableActivateItem
A focusable component with a matching key.
FocusableDirective
Tags an element as being Focusable.
FocusableItem
A focusable component that can publish to the focusmove stream in order to move focus to another element in the list.
FocusableMixin
Assistant for focusing an element.
FocusActivableItemDirective
Used in conjunction with other components to allow tagging view or content elements that should be focused either by index or key.
FocusContentWrapper
FocusItemDirective
FocusItemDirective, used in conjunction with FocusListDirective, provides a means to move focus between a list of components (or elements) by way of keyboard interaction.
FocusListDirective
Used in conjunction with FocusItemDirective or other directive implementing FocusableItem, to provide a means to move focus between a list of components (or elements) by way of keyboard interaction.
FocusMoveEvent
An event to trigger moving focus to another item in a list.
FocusTrapComponent
Focus trap designed for usage in popups and modals.
GlobalModalStack
May be added to DI to enforce that a single Modal is visible at a time.
GlyphComponent
A component that creates a material style icon. Currently only font icons are supported and material-icons-extended is the only supported font.
GlyphSize
Size names which can be used on the glyph icon.
GroupedOptions<T>
Holds a list of options for a selection-based component.
HasComparisonRange
Info needed to edit comparison ranges.
HasComponentRenderer<T extends RendersValue, I>
HasComponentRenderer defines a method that takes in an item and returns the type to use to render the item.
HasHoverIcon
Designates a model class which has a canonical icon field when it is hovered.
HasIcon
Designates a model class which has a canonical icon field.
HasRenderer<T>
Interface for a class defining itemRenderer.
HasSelectionRationale<T>
An optional interface for describing why an item is/is not selectable.
HasTabIndex
Provides computation of tabindex for components which actively maintain a tab index.
HasUIDisplayName
Designates a model class which has a canonical display name (label) field.
Highlight
A highlighted range in a calendar period. There should be one of these per block of color. E.g. if a week contains only one range, there'll be one highlight; if it has two ranges, it'll have two highlights if the ranges don't overlap, or three if they do.
HighlightAssistantMixin<T>
Assistant to support highlighting in a SelectionContainer.
HighlightedTextComponent
A component that presents a list of HighlightedTextSegments.
HighlightedValueComponent
An alternate api to HighlightedTextComponent that uses a highlighter and accepts a value that it converts to text segments using a HighlightProvider.
Icon
Simple container for icons. Models may implement this class, or the HasIcon interface.
IconSize
The values that can be used as sizes for a MaterialIconComponent.
ItemSelectionEvent
An event to represent each selection change.
KeyboardOnlyFocusIndicatorDirective
KeyboardOnlyFocusIndicatorDirective is a decorator that hides the outline on an element when the element is focused with a mouse, and shows the outline when focused with a keyboard.
KeyUpBoundaryDirective
Marks a subtree of the dom that should handle key events for a BoundaryAwareKeyDirective implementation.
LabeledValue<T>
Contains a value with ui label.
LastStateStream<T>
A stream that will provide the last item that was added to the stream to any new subscribers in addition to any new items.
LazyStreamController<T>
An implementation of StreamController that only actually creates the underlying StreamController when the stream getter is called for the first time.
LowerBoundValidator
Validator which validates that a number input is greater or equal than lowerBound.
MaterialAutoSuggestInputComponent<T>
See material_auto_suggest_input.md for an overview of the component. See examples for usage.
MaterialButtonBase
A base class from which to build buttons.
MaterialButtonComponent
A flat or raised button with an optional ripple effect.
MaterialButtonWrapper
Properties for a component which wants to expose typical options for a button: buttonText, buttonAriaLabel, disabled, icon and raised.
MaterialCalendarPickerComponent
An infinitely-scrolling material-styled calendar which supports selecting single dates or date ranges.
MaterialCheckboxComponent
material-checkbox is a button that can be either checked or unchecked.
MaterialChipComponent<T>
A "chip" widget renders an object in the 'chip' format - a rounded box with a shadow, typically used in a horizontal list. Any object implementing the HasUIDisplayName interface can be used, or no object at all.
MaterialChipsComponent<T>
A chips collection widget, displaying a list of objects as Chips.
MaterialDatepickerComponent
A material-design-styled single date picker -- a date parsing input and calendar picker. Users can type in their own custom dates, or click on the calendar to select a date.
MaterialDateRangePickerComponent
A material-design-styled date range picker.
MaterialDateTimePickerComponent
A material-design-styled single date and time picker.
MaterialDialogComponent
A styled container following the Material Spec for Dialogs.
MaterialDrawerBase
MaterialDropdownBase
Base class for Material Dropdown components.
MaterialDropdownSelectComponent<T>
See material_dropdown_select.md for an overview of the component. See examples for usage.
MaterialExpansionPanel
A material-styled expansion-panel.
MaterialExpansionPanelAutoDismiss
A directive that automatically collapses MaterialExpansionPanel.
MaterialExpansionPanelSet
A directive which will turn a set of MaterialExpansionPanels into an accordion widget, thus only allowing only one MaterialExpansionPanel to be open at a time.
MaterialFabComponent
Material FAB is a Floating Action Button. It is round, and behaves mostly the same as a MaterialButton.
MaterialFabMenuComponent
A fab menu item with optional sub menu.
MaterialFabMenuModel
View model for MaterialFabMenu.
MaterialIconComponent
A material style icon.
MaterialIconTooltipComponent
An icon that displays a paper tooltip on mouse-hover, click, enter, space, and focus.
MaterialInkTooltipComponent
An ink-based overlay meant to deliver contextual information about the element it targets.
MaterialInputBlurValueAccessor
ControlValueAccessor to be used with a MaterialInputComponent that updates on blur.
MaterialInputChangeValueAccessor
ControlValueAccessor to be used with a MaterialInputComponent that updates on change.
MaterialInputComponent
material-input is a single- or multi-line text field where user can enter input. It can optionally have a label. NOTE: Clients must declare materialInputDirectives in their directives list instead of MaterialInputComponent.
MaterialInputDefaultValueAccessor
ControlValueAccessor for MaterialInputComponent that updates on keypress.
MaterialInputWrapper
Properties for a component which wants to expose typical options for a input. See MaterialInput for fields definition.
MaterialInt64ValueAccessor
ControlValueAccessor which will coerce an input into an Int64.
MaterialListComponent
Material List is a container component for a set of items with which the user is intended to interact.
MaterialListItemComponent
Material List Item is a block element intended for user interaction; it has :hover styling and emits and trigger event when the user clicks or presses enter or space keys.
MaterialListSize
Size names (and corresponding values) for the standard widths of material-list.
MaterialMenuComponent
The Material Menu renders a menu based on a MenuModel object. This menu comprises a material-list in a material-popup and a material-button whose text or icon can be specified by the caller.
MaterialMonthPickerComponent
An material-styled calendar which supports selecting single months or month ranges.
MaterialMultilineInputComponent
material-input is a multi-line text field where user can enter input, and can optionally have a label.
MaterialNumberValidator
MaterialNumberValueAccessor
ControlValueAccessor which will coerce an input into a num.
MaterialPaperTooltipComponent
A paper based overlay meant to convey long-form contextual information about its target element.
MaterialPercentInputDirective
Directive to control material-input to accept percentage values.
MaterialPersistentDrawerDirective
A persistent drawer that can be pinned open or closed.
MaterialPopupComponent
A popup component with material design look-and-feel.
MaterialPopupRef
MaterialProgressComponent
The progress bars are for situations where the percentage completed can be determined. They give users a quick sense of how much longer an operation will take.
MaterialRadioComponent
A radio button with material style. Usually used together with material-radio-group. Once checked, same radio button can not be unchecked via user action.
MaterialRadioGroupComponent
Group containing multiple material radio buttons, enforcing that only one value in the group is selected.
MaterialRippleComponent
A component that provides a visual effect that other elements can use to simulate a rippling effect emanating from the point of contact.
MaterialSaveCancelButtonsDirective
Provides messages from yes/no buttons to be Save/Cancel.
MaterialSelectBase<T>
A SelectionContainer implementation with an additional option for setting the rendered list's width.
MaterialSelectComponent<T>
Material Select is a container for selecting items from a collection, marking selected options with a check icon.
MaterialSelectDropdownItemComponent<T>
Container for a single item selected in a dropdown.
MaterialSelectItemComponent<T>
Material Select Item is a special kind of list item which can be selected.
MaterialSelectSearchboxComponent
A simple component that maps an input box to the Filterable interface.
MaterialSliderComponent
A material slider which works for integer values.
MaterialSpinnerComponent
A circular spinner for an indeterminate amount of time following the Material Spec for Progress & Activity.
MaterialStackableDrawerComponent
A stackable temporary drawer that can be opened and closed.
MaterialStepperBackButtonTextDirective
MaterialStepperComponent
A material-design-styled stepper.
MaterialSubmitCancelButtonsDirective
Provides default messages from yes/no buttons to be Submit/Cancel.
MaterialTabComponent
A Material-styled card, which is shown or hidden as part of a MaterialTabPanelComponent.
MaterialTabPanelComponent
A component that creates a tab panel with navigation bar on the top.
MaterialTemporaryDrawerComponent
A temporary drawer that can be opened and closed.
MaterialTimePickerComponent
A material-design-styled time input component.
MaterialToggleComponent
material-toggle is a button that can be either ON or OFF.
MaterialTooltipDirective
An ink-based tooltip which can be attached to any element.
MaterialTooltipSourceDirective
An implementation of PopupSourceDirective that shows and hides the popup on keyboard and mouse events.
MaterialTooltipTargetDirective
A directive that marks the target of a tooltip and handles showing and hiding a tooltip on hover, click, and focus.
MaterialTreeComponent<T>
A material selection component that supports a tree of options.
MaterialTreeDropdownComponent<T>
A button-triggered dropdown containing a MaterialTreeComponent.
MaterialTreeExpandState
Represents the state of expansion of an option in a material tree.
MaterialTreeRenderingOptions
An object to customize material tree rendering.
MaterialYesNoButtonsComponent
A component for the two buttons horizontally next to each other, like yes/no, save/cancel, agree/not agree, etc.
Renders the list of menu item affixes.
Renders list of menu items.
A popup that renders a MenuModel using a MenuItemGroupsComponent.
Provides basic accessibility-friendly methods for showing and hiding the menu popup described by MenuPopupWrapper.
A mixin for classes that wrap a MenuPopupComponent.
An ADT that can be injected by content that lives within a modal.
ModalComponent
A transcluding component that hosts inner content in a centered overlay.
ModelState
A snapshot of the state of the _Model.
MonthRange
Lightweight class representing one or more consecutive months.
MultiDropdownSelectValueAccessor<T>
ControlValueAccessor for material dropdown select which only allows multi-selection allowing integration with the angular forms API.
MultiReorderEvent
An event data emitted when multiSelect is set to true.
MultiSelectionModel<T>
NextPrevComponent
Next/prev buttons.
NgModel
Creates a form NgControl instance from a domain model and binds it to a form control element. The form NgControl instance tracks the value, user interaction, and validation status of the control and keeps the view synced with the model.
NullSelectionModel<T>
OptionGroup<T>
A collection of options with an optional label.
Parent<P, C>
Interface implemented by classes that support children.
PercentagePopupSizeProvider
A popup size provider that determines the popup size based on a fixed percentage of the current viewport size.
PopupBase
A partial that implements the setters of PopupBase by writing to state.
PopupComposite
A partial that stores all fields in PopupInterface to be sent further down the component tree using change detection.
PopupEvents
A partial that implements the events of PopupInterface with new emitter.
PopupHierarchy
Tracks a hierarchy of visible popup and provides it closing logic.
PopupHierarchyElement
An electable element for the PopupHierarchy.
PopupInterface
A reusable interface for something that is or delegates to PopupComponent.
PopupPosition
PopupPositionMixin
Assistant for supporting custom preferred popup positions.
PopupRef
A handle to manipulate an existing popup.
PopupSizeProvider
A handler that provides max width and max height of a popup based on its position and the current viewport size.
PopupSizeProviderDirective
Directive to provide maximum and minimum sizes to a popup from html.
PopupSource
The source of where a popup will be created from.
PopupSourceDirective
A directive that exposes the PopupSource interface as popupSource.
PopupState
The internal state (model) of a popup.
PopupWithinViewportDirective
Applies a WithinViewportPopupSizeProvider to the attached element and its descendants.
PositiveNumValidator
Validator which will validate a number input is positive > 0.
PriorityStreamIterator<T extends Comparable<Object>>
A StreamIterator that accumulates the Stream's values into a priority queue and selects the one with the most priority (the least one by comparison) of all accumulated values at each moveNext call.
ProjectedFocus
RadioGroupSingleSelectionModel<T>
Single selection model that always has a value selected
RelativePosition
A position relative to another point in a 2-dimensional plane.
RendersValue<T>
Interface to render a value.
ReorderEvent
An event data emitted after single drag element is dropped.
ReorderHandleDirective
Indicates the element with this directive is the drag handle for the containing reorderItem.
ReorderHandleProvider
Interface that will return a ReorderHandleDirective for use as a handle of a component marked as a reorderItem inside a reorder-list.
ReorderItemDirective
Indicates that the element is a list item in the containing reorder-list component. See ReorderListComponent for usage.
ReorderListComponent
Provides a list that can reorder it's children using html5 drag&drop. A vertical reorder-list will use any component in its
RootFocusable
A class for components to extend if their programmatic focus should simply put focus on root element.
ScoreboardComponent
This component manages a row of scorecards.
ScorecardComponent
Standalone scorecard component.
Selectable<T>
Interface for determining if an entity T should be shown as selectable.
SelectionChangeNotifier<T>
Mixin for providing SelectionModel.selectionChanges.
SelectionChangeRecord<T>
A change record for SelectionModel.selectionChanges.
SelectionModel<T>
Provides pattern to manage a collection of selected values. This is used in model-view architecture to notify interested parties of changes to selection.
SelectionObservable<T>
Interface for something that can be observed for selection.
SelectionOptions<T>
Holds a list of options for a selection-based component.
Sequential<T>
Something that can move to a next/previous element.
ShiftClickSelectionMixin<T>
Handles toggling selection of a range of options when shift is held down while clicking on the end value.
SimpleEmitter<T>
Provides an interface for both StreamController and Stream for use with output events in Angular components.
SimpleStream<T>
A ListenOnly Implementation of a Stream. It only supports the listen method with the onData parameter. Additionally, the streamsubscription can only be cancelled. This also acts like a StreamController via the add method.
SimpleStreamSubscription<T>
A SimpleStream implementation of StreamSubscription.
SingleSelectionModel<T>
StepDirective
A step within the stepper.
StopPropagationDirective
A directive that prevents button trigger events from propagating.
StringSelectionOptions<T>
The class is meant to be used in areas where a selection can be represented as a string.
SummaryDirective
A TemplatePortal which is used to house an optional summary view for a StepDirective.
Tab
Basic interface for a Tab.
TabButtonComponent
A specialized button component used only by the tab strip.
TabChangeEvent
The event fired when tab is about to switch or has switched to a new one.
TabMixin
A mixin for use by tab button component and tab dropdown menu component.
TimeSelectionOptions
StringSelectionOptions for DateTime dropdown selector.
Tooltip
Lightweight interface for Tooltip components to implement so they can be controlled by a TooltipController.
TooltipBehavior
Class incorporating the common behavior of a Directive that marks the target of a tooltip.
TooltipTarget
Base class for tooltip targets.
TrackLayoutChangesMixin
Mixin for trackLayoutChanges property pass through to material popup to avoid duplicate code in multiple components.
UpperBoundValidator
Validator which validates that a number input is less or equal than upperBound.
WithinViewportPopupSizeProvider
Constrains popups to fit within the viewport's bottom and right edges.
YearRange
Lightweight class representing one or more consecutive years.
ZonedFuture<T>
A wrapper around an existing Future that processes all events received within a specific zone, instead of the default behavior of processing them in the zone that the then originated.
ZonedStream<T>
A wrapper around an existing Stream that processes all events received within a specific zone, instead of the default behavior of processing them in the zone that the listen originated.

Enums

Action
The cause of the most recent change to the date range.
BottomPanelState
Represents which label should be shown in the BottomPanel
CalendarResolution
A minimum relevant time unit for a calendar.
CalendarSelectionMode
What sort of selections a calendar supports.
CausedBy
Describes the interaction state arising directly from the most recent user action that produced any particular CalendarState. external - State arose programmatically / by default / from a user action outside of the calendar widget itself. preview - User is previewing a possible selection change. drag - User is dragging on the calendar widget and has not finished yet. endpointConfirm - The previous preview has now confirmed a single endpoint rangeConfirm - The previous preview/drag is now confirmed/finished.
DateRangePickerConfiguration
Possible date range picker configurations.
ScoreboardType
The interaction type of the scoreboard.
SelectableOption
Enum that specifies checkbox state for selectable item.

Constants

all → const String
animationDuration → const Duration
ARIA_VALUENOW_ATTR → const String
backwards → const String
checkedIcon → const Icon
checkIntegerErrorKey → const String
clockValue → const Clock
darkThemeClass → const String
The class applied to elements which have been themed, iff the dark theme is active.
darkThemeToken → const OpaqueToken<bool>
Sets dark mode for components which support it.
datepickerBindings → const List<Object>
Standard bindings needed by material datepicker components.
datepickerClock → const OpaqueToken<Object>
defaultDateComparison → const OpaqueToken<Object>
DI token for specifying a default date range with a comparison range, intended to be consumed by some client-specified bindings for a DatepickerModel.
defaultDateRange → const OpaqueToken<Object>
DI token for specifying a default date range, intended to be consumed by some client-specified bindings for a DatepickerModel.
defaultPopupPositions → const OpaqueToken<List<RelativePosition>>
A token representing a List of RelativePositions to use when popup auto positioning is set (enforceSpaceConstraints) but no custom positions (preferredPositions) are set.
horizontal → const String
inlinePositions → const List<RelativePosition>
inputNotNumberErrorKey → const String
jumps → const List<String>
materialDirectives → const List
A convenience list of all Directives exposed by this package.
materialInputDirectives → const List<Type>
A list of all material input directives.
materialInputErrorKey → const String
Key used in the Control's error map, when there is an error.
materialNumberInputDirectives → const List<Type>
materialProviders → const List
A convenience list of all providers exposed by this package.
materialTooltipBindings → const List<ClassProvider<Object>>
materialTooltipModule → const Module
materialTreeLeftPaddingToken → const OpaqueToken<Object>
none → const String
nonNegativeIntegerRequiredErrorKey → const String
noSelectionIndex → const int
nullRenderer → const ItemRenderer
An ItemRenderer that indicates that components should not render items.
numberAboveUpperBoundErrorKey → const String
numberBelowLowerBoundErrorKey → const String
orientations → const List<String>
overlayBindings → const List<List<Provider<Object>>>
DI bindings for Overlay and its dependencies.
overlayContainerName → const OpaqueToken<String>
An opaque token for the name of the overlay container, if any.
overlayContainerParent → const OpaqueToken<HtmlElement>
Where overlayContainerToken should be created.
overlayContainerToken → const OpaqueToken<HtmlElement>
An opaque token of the DOM element that is the container.
overlayDebugBindings → const List<List<Object>>
Similar to overlayBindings, but enables easy debugging of the overlays.
overlayDebugModule → const Module
Similar to overlayModule, but enables easy debugging of the overlays.
overlayModule → const Module
DI module for Overlay and its dependencies.
overlayRepositionLoop → const OpaqueToken<bool>
Flag whether to reposition popups on every frame when trackLayoutChanges is true.
overlaySyncDom → const OpaqueToken<bool>
Flag whether to use synchronous reads/writes instead of async.
overlayViewportBoundaries → const OpaqueToken<Object>
An token to provide custom viewport boundaries for popups.
popupBindings → const List<List<Object>>
DI bindings for Popups and its dependencies.
popupDebugBindings → const List<List<Object>>
DI bindings for Popups and its dependencies with debugging enabled.
popupDebugModule → const Module
DI module for Popups and its dependencies with debugging enabled.
popupModule → const Module
DI module for Popups and its dependencies.
positiveIntegerRequiredErrorKey → const String
rtlProvider → const FactoryProvider<Object>
rtlToken → const OpaqueToken<Object>
Annotation bound to a boolean which is used to indicate that a complete web page is RTL.
sizeDefault → const String
sizeMini → const String
sizes → const List<String>
timeZoneAwareDatepickerModule → const Module
timeZoneAwareDatepickerProviders → const List<List<Provider<Object>>>
Bindings needed by material datepicker components, for clients who need to set a custom time zone.
tooltipControllerBinding → const FactoryProvider<Object>
Factory for TooltipController.
tooltipShowDelay → const Duration
unboundedPopupSize → const FixedPopupSizeProvider
A popup size provider of no maximum size.
uncheckedIcon → const Icon
vertical → const String

Properties

alwaysFalse ↔ Predicate
getter/setter pair
alwaysTrue ↔ Predicate
getter/setter pair

Functions

asyncFirst<T>(List<T> items, Future<bool> filter(T item), {T orElse()?}) → Future<T>
Returns a future that completes with the first item in items for which filter returns a future that completes with true. It completes with an item only when its filter future completes with true AND the filter futures for all previous items have completed. If all filter futures complete with false and orElse is absent, completes with an error. If all filter futures complete with false and orElse is present, completes with the return value of orElse.
asyncSingle<T>(List<T> items, Future<bool> filter(T item)) → Future<T>
Returns a future that completes with the unique item in items for which filter returns a future that completes with true. It completes with an item only when its filter future completes with true AND all the other filter futures complete with false. If all filter futures complete with false or (at least 2 complete with true and all the ones before them complete), then it completes with an error.
asyncWhere<T>(List<T> items, Future<bool> filter(T item)) → Stream<T>
Returns a single-subscription stream of the items for which the filter returns a future that completes with true. The stream fires an event for an item only when its future completes with true AND the filter futures for all previous items have completed.
compareDatesAtResolution(Date a, Date? b, CalendarResolution resolution) → int
createAcxOverlayContainer(Object parent, {required String id, required String name, String? className}) → HtmlElement
Creates an overlay container inside the parent if one does not exist already. A hidden focusable element is inserted before and after the overlay container to support a11y features.
createTooltipController(TooltipController? controller, Disposer? disposer) → TooltipController?
datesEqualAtResolution(Date? a, Date? b, CalendarResolution resolution) → bool
daysSpanned(Date start, Date end, {bool inclusive = true}) → int
The number of days spanned by the range defined by the two dates. Defaults to including the end date, so that daysSpanned(d, d) == 1.
debounceStream<S, T>(Duration duration) → StreamTransformer<S, T>
Debounces a stream, preventing it from triggering until duration has passed between events.
decimalNumberFormat() → NumberFormat
defaultItemRenderer(dynamic value) → String
defaultPresets(Clock clock) → List<DatepickerPreset>
The default list of presets to use in material-date-range-picker.
determineRtl(Document document) → bool
earlierOf(Date a, Date? b) → Date?
Gets the earlier of the two given dates.
enumerateDates(Date start, Date? end) → Iterable<Date>
Enumerates all dates from start to end, inclusive.
enumerateRange(DateRange? range) → Iterable<Date>
Enumerates all dates from range.start to range.end, inclusive.
firstDayOfMonth(Date? date) → Date?
fromDropdown(MaterialDropdownSelectComponent dropdown) → ActiveItemModel
getDebugContainer(Object name, Object parent) → HtmlElement
Returns an overlay container with debugging aid enabled.
getDefaultContainer(Object name, Object parent, Object? container) → HtmlElement
Either finds, or creates an "acx-overlay-container" div at the end of body.
getDefaultContainerName(Object? containerName) → String
getHierarchy(MaterialPopupComponent c) → PopupHierarchy?
getOverlayContainerParent(Document document, Object? containerParent) → HtmlElement
getResolvedPopupRef(MaterialPopupComponent c) → PopupRef?
lastDayOfMonth(Date? date) → Date?
laterOf(Date a, Date? b) → Date?
Gets the later of the two given dates.
newCachingItemRenderer<T>(ItemRenderer<T> itemRenderer) → ItemRenderer<T>
Returns an ItemRenderer that caches the results of calls. It should be used in Selection widgets.
rangeContains(DateRange range, Date? date) → bool
Whether or not date is inside range.
rangeContainsRange(DateRange range, DateRange subrange) → bool
Whether or not subrange is fully contained by range.
replaceErrors(Map<String, String> overrides) → ErrorFn
Convenience function for replacing multiple errors for Components using the errorRenderer pattern.
throttleStream<S, T>(Duration duration, {bool guaranteeLast = true}) → StreamTransformer<S, T>
Throttles a stream, triggering events at most once per duration.

Typedefs

AsyncMeasureSize<E> = Stream<Rectangle<num>> Function(E element, {bool track})
A handler to return the position and size of the content of element.
CharacterCounter = int Function(String? inputText)
ComponentRenderer<T extends RendersValue, I> = Type Function(I? item)
Defines a method that returns a component to render the Item. The component must implement RendersValue.
CountGetter = int Function()
ErrorFn = Map<String, dynamic>? Function(Map<String, dynamic>? errors)
A function which takes in an error map, and returns another modified errors map.
InputChangeCallback = dynamic Function(Object inputText, {String rawValue})
ItemRenderer<T> = String? Function(T item)
Definition for a method that takes in an item and converts it to a string.
KeyProvider<T> = Object? Function(T o)
Returns a key-able object from o.
MatchCallback = Future<List> Function(String string)
Matching function provider, for example used in SelectSuggestInput.
NextPrevCallback = void Function()
OnUpdateCallback = void Function()
A callback registered with AsyncNotifier.
OptionGroupMapper<T> = List<OptionGroup<T>> Function(Iterable<T> items)
An interface for functions that segment items into option groups.
Predicate<T> = bool Function(T item)
RangeFormatter = String Function(DateRange? range)
Custom date range formatter interface.
ReorderListHandler = void Function(int sourceIndex, int destIndex)
RunInZoneFn = dynamic Function(dynamic fn())
Runs fn within a zone.
SelectableGetter<T> = SelectableOption Function(T entity)
SetPropertyFn = void Function(String? propertyName, dynamic propertyValue)
A function that sets propertyName to propertyValue.
StreamCallbackFunc<T> = void Function(T value)
StreamCallContextFunc = void Function(dynamic func())
StreamControllerFactory<T> = StreamController<T> Function()
Creates a stream controller.
StringSuggestionFilter<T> = bool Function(T suggestion, String filterQuery)
SubscriptionChangeListener<T> = void Function(StreamSubscription<T> subscription)
TrackFunction = Object? Function(int i, dynamic d)
ValidatorFn = Map<String, dynamic>? Function(AbstractControl c)
ValidityCheck = String Function(String? inputText)