m4d library

Support for doing something awesome.

More dartdocs go here.

Classes

Action
Simples form of an Action [...]
ActionBus
Main-Class for sending Actions
ActionBusImpl
Implements the ActionBus-interface via Streams ActionBus is registered by default for DI [...]
ActionName
Strong-Typed ActionName [...]
AnimationState
Sets animation-states [...]
AnimationTiming
Timing constants
ChooseFormatter
Choose between two Text options. ChooseFormatter must be registered in mdlformatter.Formatter Sample:
ConvertValue
Converts dynamic values to strong-typed values
CoreComponentsModule
DataAction<T>
This Action carries a data-package [...]
DataAttribute
Helper for requesting a proper value from the components HTML-Element [...]
DataProvider
DataStore
The DataStores are responsible for managing business logic and data. [...]
DataStoreChangedEvent<T extends Action>
Received by a concrete implementation of DataStore if something has changed in the DataStore
DataTableChangedEvent
DataTableRowClickedEvent
If user clicks on a row this Event will be triggered
DecoratorFormatter
Just for Testing
DefaultSimpleDataStore
Default implementation for SimpleValueStore [...]
DialogConfig
Configuration for DialogElement
DialogModule
DirectivesModule
Dispatcher
The Dispatcher is the central hub that manages all data flow in a MDL(Flux) application. [...]
DNDModule
DomRenderer
DomRenderer converts a String into HtmlNodes
DragInfo
Singleton - used by MaterialDraggable and MaterialDroppable
DummyController
ElementProperties
Emitter
This is the base class for DataStore so it's not really a DataStore but if you need an object that informs others about an internat change-state the Emitter can help you [...]
EventCompiler
Connects data-mdl-event attributes with object-functions [...]
FallbackFormatter
Helper-Class to get the right MaterialFormatter if a MdlComponent could have registered more than one MaterialFormatter [...]
FireOnlyDataStore
Fire-Only DataStore [...]
Formatter
Base-Class for all Formatters
FormatterModule
Registers the necessary Objects [...]
FormatterPipeline
Takes the return value of the first command as input for the next command - works like "unix pipes" Basis is a HTML-Statement like this: [...]
Formatters
Formatter ist a collection of formatters. [...]
FormChangedEvent
FormModule
FromJson
Marker for all objects that can be deserialize from Json
HasDynamicParentScope
For Components like _MaterialDialogComponent where it's necessary to change the ParentScope at runtime. For example if MaterialDialog pops up the Parent-Scope is set to the new Dialog
JsonAction<T extends ToJson>
This Action carries a special data-package. The data-package can be serialized to JSON [...]
JsonObject
Marker for all objects that can be serialized and deserialize from Json
ListChangedEvent<T>
Propagated if List changes
LowerCaseFormatter
Converts input to lowercase. [...]
M4DListComponent
M4DService
Base for all Service-Classes [...]
MaterialAccordion
Sample: [...]
MaterialAlertDialog
MaterialApplication
Basis for your Application [...]
MaterialAttribute
Checks the given condition and adds the given attribute to the components element. Format: ! : '' [...]
MaterialBadge
Controller-View for
MaterialButton
Controller-View for [...]
MaterialCheckbox
Controller-View for [...]
MaterialClass
Checks the given condition and adds the given class-name to the components element. Format: ! : '' [...]
MaterialContent
MaterialContent is ScopeAware - this means that it can be found by child-MaterialComponent looking for Data (like MaterialRepeat [...]
MaterialContentEvent
MaterialController
MaterialDataTable
MaterialDatePicker
Shows a Date-Picker dialog [...]
MaterialDialog
HTML-Part of MdlDialog.
MaterialDialogComponent
Private Component! (not true - since 20. June 18 because Injector needs this class to be public!) [...]
MaterialDivDataTable
Controller for
MaterialDivDataTableRow
Controller for [...]
MaterialDraggable
MaterialDropZone
MaterialDummyFormatter
Created if a MaterialComponent has no MaterialFormatter registered but asks for one [...]
MaterialFormatter
Controller for [...]
MaterialFormComponent
Upgrades mdl-form und does some validation checks. [...]
MaterialIconToggle
Controller-View for [...]
MaterialInclude
MaterialLabelfield
Controller-View for [...]
MaterialLayout
Controller-View for
MaterialLayoutTab
Individual Tab
MaterialMenu
Controller-View for [...]
MaterialModel
Usage (HTML): [...]
MaterialNotification
MaterialNotification
MaterialProgress
Controller-View for
MaterialProgressVertical
Controller-View for
MaterialRadio
Controller-View for [...]
MaterialRadioGroup
MaterialRadioGroupChangedEvent
Fired by MaterialRadioGroup on childChanged
MaterialRipple
MaterialSlider
MaterialSnackbar
MaterialSnackbarComponent
MaterialSpinner
MaterialSwitch
Controller-View for [...]
MaterialTabs
Controller-View for mdl-tabs [...]
MaterialTabsChangedEvent
MaterialTextfield
Controller-View for [...]
MaterialTimePicker
Shows a Date-Picker dialog [...]
MaterialTooltip
MaterialTranslate
Translate [...]
MdlAnimation
MdlAnimation simplifies the use of CSS3 animations. [...]
MdlAnnotation
Mustache (+mirrors) needs to know which classes to include
MdlComponent
MdlComponentHandler
A component handler interface using the revealing module design pattern. More details on this pattern design here: https://github.com/jasonmayes/mdl-component-design-pattern (JS-Version: Jason Mayes.) [...]
MdlConfig<T extends MdlComponent>
MdlConfirmDialog
MdlDataConsumer
MdlEventListener
Mixin to cleanup StreamSubscriptions for MdlComponents and MaterialDialogs [...]
MdlPublicFunctionAnnotation
Helper for Transformer to generate documentation
MdlTemplateComponent
Basis for all MdlComponents with Templates
MdlWidgetConfig<T extends MdlComponent>
Helps to decide what is a real Widget and what is just a helper. MaterialRipple would be such a "helper" [...]
ModelObserver
ModelObserverFactory
NumberFormatter
Formats a number with a certain number of digits [...]
ObservableList<T>
List that sends ListChangeEvents to the listener if this list changes Supported methods: Add, insert, update ([]), remove, clear, removeAll [...]
ObservableProperty<T>
PropertyChangeEvent<T>
ReactPattern
If pattern starts with / and has no hash ReactPattern automatically prefixes pattern with '/#' [...]
RefreshableComponent
MdlComponent that has a "refresh" Functions. Best way to invoke this function is via refreshComponentsInSubtree [...]
Renderer
Exchangeable Render function. {TemplateRenderer} or {ListRenderer} are returning this. {MdlTemplateComponent} has a Renderer for rendering. [...]
Route
RouteEnterEvent
RouteErrorEvent
Event on error
RouteEvent
Route enter event.
Router
Stores a set of UrlPattern to Handler associations and provides methods for calling a handler for a URL path, listening to Window history events, and creating HTML event handlers that navigate to a URL.
SimpleDataObject
Needed for M4DListComponent
SimpleDataStoreMixin
Mixin for simplifying the integration into your own App-Store
SnackbarPosition
Position on Screen or in container
SPAModule
StockAnimation
Predefined animations. [...]
StringToFunction
Splits a String int function name and params [...]
TemplateComponent
TemplateModule
TemplateRenderer
ToJson
Marker for all objects that can be serialized to Json
ToJsonEvent<T extends ToJson>
Creates a JSON-Map [...]
TranslationModule
UpdateView
Stock-Action that is emitted by the Dispatcher.emitChange-Function
UpperCaseFormatter
Converts input to uppercase [...]
UrlPattern
A pattern, similar to a RegExp, that is designed to match against URL paths, easily return groups of a matched path, and produce paths from a list of arguments - this is they are "reversible". [...]
ViewFactory
Loads additional "views" (html-Page) in SPA-Application [...]

Constants

Component → const MdlAnnotation
All MDLComponents
const MdlAnnotation()
Directive → const MdlAnnotation
Directives like Formatter
const MdlAnnotation()
MDL_COMPONENT_PROPERTY → const String
Property for the Components JsObject to save/register the component
"mdlcomponent"
MdlComponentModel → const MdlAnnotation
Helps dryice to know which vars are available to render [...]
const MdlAnnotation()
Model → const MdlAnnotation
Usually used for Templates
const MdlAnnotation()
public → const MdlPublicFunctionAnnotation
UpdateViewAction → const UpdateView
const UpdateView()

Functions

componentFactory() MdlComponentHandler
componentHandler() MdlComponentHandler
getAllMdlComponents(HtmlElement element) → List<MdlComponent>
Returns all MdlComponents in subtree
isMdlComponent(HtmlElement element, [ Type type ]) → bool
Checks if element is a "MDLComponent" type is optional - if given a stricter check is made
isMdlWidget(HtmlElement element) → bool
Checks if element is a "Widget" (usually this means a UI-Element) MdlConfig.isWidget...
materialAccordionConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialAccordion
materialCheckboxConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialCheckbox
materialContentConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialContent
materialIconToggleConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialIconToggle
materialIncludeConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialInclude
materialLayoutConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialLayout
materialMenuConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialMenu
materialProgressConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialProgress
materialProgressVerticalConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialProgressVertical
materialRadioConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialRadio
materialRadioGroupConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialRadio
materialRippleConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialRipple Important!!!! Ripple uses MdlConfig and not MdlWidgetConfig
materialSliderConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialSlider
materialSpinnerConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialSpinner
materialSwitchConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialSwitch
materialTabsConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialTabs
materialTextfieldConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialTextfield
materialTooltipConfig() MdlConfig<MdlComponent>
creates MdlConfig for MaterialTooltip
mdlComponent(HtmlElement element, Type type, { bool showWarning: true }) MdlComponent
element The element where a MDL-Component is registered [...]
mdlComponentNames(HtmlElement element) → List<String>
Gives you all the component names registered for this element
mdlComponents(HtmlElement element) → List<MdlComponent>
Returns all the MDL-Components registered for this element
refreshComponentsInSubtree(HtmlElement element) → void
registerContentComponents() → void
registerM4DListComponent() → void
registration-Helper
registerM4DTemplateComponents() → void
registerM4DTranslationComponents() → void
registerMaterialAccordion() → void
registration-Helper
registerMaterialAttribute() → void
registration-Helper
registerMaterialBadge() → void
Registers the MaterialBadge-Component [...]
registerMaterialButton() → void
Registers the MaterialButton-Component [...]
registerMaterialCheckbox() → void
registration-Helper
registerMaterialClass() → void
registration-Helper
registerMaterialContent() → void
registration-Helper
registerMaterialDataTable() → void
registration-Helper
registerMaterialDivDataTable() → void
registration-Helper
registerMaterialDraggable() → void
registration-Helper
registerMaterialDropZone() → void
registration-Helper
registerMaterialFormatter() → void
Registers the MaterialFormatter-Component [...]
registerMaterialFormComponent() → void
registration-Helper
registerMaterialIconToggle() → void
registration-Helper
registerMaterialInclude() → void
registration-Helper
registerMaterialLabelfield() → void
Registers the MaterialLabelfield-Component [...]
registerMaterialLayout() → void
registration-Helper
registerMaterialMenu() → void
registration-Helper
registerMaterialModel() → void
registration-Helper
registerMaterialProgress() → void
registration-Helper
registerMaterialProgressVertical() → void
registration-Helper
registerMaterialRadio() → void
registration-Helper
registerMaterialRadioGroup() → void
registration-Helper
registerMaterialRipple() → void
registration-Helper
registerMaterialSlider() → void
registration-Helper
registerMaterialSpinner() → void
registration-Helper
registerMaterialSwitch() → void
registration-Helper
registerMaterialTabs() → void
registration-Helper
registerMaterialTextfield() → void
registration-Helper
registerMaterialTooltip() → void
registration-Helper
registerMaterialTranslate() → void
registration-Helper
registerMdlComponents() → void
registerMdlDialogComponents() → void
registerMdlDirectiveComponents() → void
registerMdlDND() → void
registerMdlFormComponents() → void
sanitizeResponseText(String responseText) → String
If responseText is a HTML-Page with header and body the contents within "body" will be extracted
splitConditions(String conditionToSplit) → Map<String, String>
Splits conditionToSplit into varnames and classnames. Format: : '', : '' ...
urlPattern(String pattern) UrlPattern
waitUntil(bool test(), { int maxIterations: 100, Duration step: const Duration(milliseconds: 10) }) → Future<int>
Waits until test returns true [...]

Enums

ActionType
Gives you more infos about the action you receive [...]
ListChangeType
MaterialFormState
MdlDialogStatus
NotificationType
RegistrationPriority
SelectorType

Typedefs

EventHandler(Event e) → void
FormatObservedValue<T>(T value, dynamic original, { String format }) → String
GetZoneNamesCallback() → List<String>
Handler(String path) → dynamic
IsFormValidCallback(MaterialFormState originalState) → bool
Callback can be set as a last resort for validation checks [...]
MdlAnimationComplete() → void
Callback function type
MdlAnimationStream(StreamSubscription<EventListener> subscription) → dynamic
MdlCallback(HtmlElement element) → void
MdlComponentFactory(HtmlElement element, Container iocContainer) MdlComponent
ModelObserverBuilder(MdlComponent component) ModelObserver
OnCloseCallback(MaterialDialog dialog, MdlDialogStatus status) → void
Called if ESC is pressed or if the user clicks on the backdrop-Container
PipeCommand(dynamic val) → dynamic
ResetObserver<T>() → T
RouteEnterCallback(RouteEnterEvent event, [ void onError(Exception exception) ]) → void
StaticCast<T>(dynamic value) → T
UpdateItem<T>(HtmlElement element, T item) → bool

Exceptions / Errors

MultipleWidgetException
Thrown if you try to register more than one widget per element Multiple components per element are allowed but not multiple widgets!
WrongComponentTypeException