bones_ui_kit library

Bone UI - Kit

Exports bones_ui + extra useful packages.

Classes

AnyUriPolicy
Allows anu Uri policy.
AsDOMElement
Interface for objects that can be cast as DOMElement.
AsDOMNode
Interface for objects that can be cast as DOMNode.
AsyncValue<T>
A wrapper and handler for a value that is asynchronous (from a Future).
AudioFileReader
Authorization
Represents a kind of HTTP Authorization.
Base64
Base-64 utils.
BasicCredential
A HTTP Basic Credential for the Authorization header.
BearerCredential
A HTTP Bearer Credential for the Authorization header.
BonesUI
BUIElementGenerator
BUIManifest
BUIManifestRender
BUIRender
BUIRenderSource
BUIView
BUIViewProvider
BUIViewProviderBase
CachedComputation<R, T, K>
Caches a value that can be computed.
CalendarEvent
CanvasImageViewer
An image viewer that can render points, rectangles, clip and grid over.
CAPTIONElement
CHECKBOXElement
Color
Represents a color.
ColossusPaging
Implementation for Colossus.services DB and Nodes.
Completer<T>
A way to produce Future objects and to complete them later with a value or error.
ConfigDocument
ContextualResource<T, C extends Comparable<C>>
Wraps a resource and the related context.
ContextualResourceResolver<T, C extends Comparable<C>>
Resolves a resource based into a context, like screen dimension or OS.
Credential
Abstract Credential for HttpRequest.
CSS
CSS entries.
CSSAnimationConfig
CSSAnimationConfigElements
CSS animation configuration for a List<Element>.
CSSAnimationConfigGroup
CSS animation configuration for a group of CSSAnimationConfig.
CSSBackground
A CSS background value.
CSSBackgroundGradient
A CSS background gradient value.
CSSBackgroundImage
CSSBorder
A CSS border value.
CSSCalc
A CSS calc(...) value.
CSSColor
Base class for CSS colors.
CSSColorHEX
A CSSColor in HEX (no alpha).
CSSColorHEXAlpha
A CSSColor in HEX with alpha.
CSSColorName
A CSSColor by name.
CSSColorRGB
A CSSColor in RGB.
CSSColorRGBA
CSSEntry<V extends CSSValue>
A CSS entry (a pair of key and CSSValue).
CSSFunction
Base class for a CSSValue that is a CSS function.
CSSGeneric
A generic CSS value.
CSSLength
A CSS value that represents a length with a unit.
CSSMax
A CSS max(...) value.
CSSMin
A CSS min(...) value.
CSSNumber
A CSS value that represents a number (without a unit).
CSSProvider
CSSThemeSet
A Theme set, with multiples themes.
CSSURL
A CSS url(...) value.
CSSValue
Base class for CSSEntry values.
CSSValueBase
DataAssets
A collections of assets (DataURL, Blob, MediaSource) that can be accessed by an ObjectURL, avoiding usage and encoding to data URL (base64).
DataCallHttp
Represents a HttpCall to request data.
DataHandler<T>
Base class for DataSource and DataReceiver.
DataReceiver<T>
Represents a data receiver, that can store or process data.
DataReceiverDynCall<T>
A DataReceiver based in a DynCall for requests.
DataReceiverExecutor<E, T>
A DataReceiver based in a DynCallExecutor for requests.
DataReceiverHttp<T>
A DataReceiver based in a DataCallHttp for requests.
DataRepository<T>
Represents simultaneously a DataSource and a DataReceiver.
DataRepositoryHttp<T>
A DataRepository based in a DataCallHttp for requests.
DataRepositoryWrapper<T>
Represents a DataRepository that wraps a DataSource instance and a DataReceiver instance
DataSource<T>
Represents a Data source
DataSourceCall<T>
DataSourceDynCall<T>
A DataSource based in a DynCall for requests.
DataSourceExecutor<E, T>
A DataSource based in a DynCallExecutor for requests.
DataSourceHttp<T>
A DataSource based in a DataCallHttp for requests.
DataSourceOperationHttp<T>
DataSourceResolver<T>
Wrapper to resolve a DataSource.
DataSourceResponse<T>
DataStorage
Represents a persistent storage in the browser.
DataURLBase64
Represent a Data URL in Base-64
Dimension
Represents a width X height dimension.
DIVElement
Class for a div element.
DOMAction<T>
DOMActionCall<T>
DOMActionExecutor<T>
DOMActionList<T>
DOMActionSelect<T>
DOMAsync
A DOMNode that will be defined in the future.
DOMAttribute
Represents a DOMElement attribute entry (name and DOMAttributeValue).
DOMAttributeValue
Base class for DOMAttribute value.
DOMAttributeValueBoolean
DOMAttributeValueCollection
Base DOMAttributeValue class for collections.
DOMAttributeValueCSS
A DOMAttributeValue of type CSS.
DOMAttributeValueList
A DOMAttributeValue of type List.
DOMAttributeValueSet
A DOMAttributeValue of type Set.
DOMAttributeValueString
A DOMAttributeValue of type String.
DOMAttributeValueTemplate
Attribute value when has template syntax: {{...}}
DOMContext<T>
Represents the context of this DOM tree.
DOMElement
A node for HTML elements.
DOMEvent<T>
Base class for DOMElement events.
DOMGenerator<T>
Basic class for DOM elements generators.
DOMGeneratorDartHTML<T>
DOMGeneratorDelegate<T>
Delegates operations to another DOMGenerator.
DOMGeneratorDummy<T>
A dummy DOMGenerator implementation.
DOMMouseEvent<T>
Represents a mouse event.
DOMNode
Represents a DOM Node.
DOMNodeMapping<T>
A wrapper for a mapped pair of a DOMTreeMap.
DOMNodeRuntime<T>
Wraps the actual generated node T and allows some operations over it.
DOMNodeRuntimeDummy<T>
DOMTemplate
DOMTemplateBlock
DOMTemplateBlockCondition
DOMTemplateBlockElse
DOMTemplateBlockElseCondition
DOMTemplateBlockElseIf
DOMTemplateBlockElseNot
DOMTemplateBlockIf
DOMTemplateBlockIfCmp
DOMTemplateBlockIfCollection
DOMTemplateBlockNot
DOMTemplateBlockQuery
DOMTemplateBlockVar
DOMTemplateBlockVarElse
DOMTemplateContent
DOMTemplateIntlMessage
DOMTemplateNode
DOMTemplateVariable
DOMTreeMap<T>
Represents a mapping tree. Can be used to map a DOMNode to a generated node T, or a node T to a DOMNode.
DOMTreeMapDummy<T>
A Dummy DOMTreeMap, that won't map anything.
DOMTreeReferenceMap<V>
A TreeReferenceMap for DOM Nodes.
DSX<T>
A DSX object.
DSXResolver<T>
DSXType<T>
DynCall<E, O>
A Dynamic Call specification
DynCallCredential
Abstract class for credentials.
DynCallCredentialHTTP
A HTTP Credential.
DynCallExecutor<E>
Abstract class for the executor implementation.
DynCallFunctionExecutor<R, T>
A DynCallExecutor that calls a DynCallFunction for results.
DynCallHttpClient
A HTTP Client for DynCallHttpExecutor calls.
DynCallHttpExecutor<E>
A DynCallExecutor for HTTP calls.
DynCallHttpExecutorFactory
A Factory that helps to define/attach HTTP executors to calls.
DynCallHttpExecutorFactory_builder<E, O>
The Builder returned by Factory call(...) method.
DynCallStaticExecutor<E>
Static DynCallExecutor, with predefined results.
ElementGenerator<T>
ElementGeneratorBase
ElementGeneratorFunctions<T>
ElementProvider
EventHandlerPrivate
EventSink<T>
A Sink that supports adding errors.
EventStream<T>
Implements a Stream for events and additional features.
EventStreamDelegator<T>
A delegator for EventStream.
ExplorerModel
ExternalElementNode
Class wrapper for a external element as a DOMNode.
FieldLengthValidator
FieldNormalizerGroup
FieldValidatorGroup
FilterResult
Filter result.
Future<T>
The result of an asynchronous computation.
FutureOr<T>
A type representing values that are either Future<T> or T.
Geolocation
Represents a Geo Location in latitude and longitude.
HSLColor
A color represented using alpha, hue, saturation, and lightness.
HSVColor
A color represented using alpha, hue, saturation, and value.
HtmlUnescape
A Converter that takes HTML5-escaped strings (like &pm;42) and unescapes them into unicode strings (like ±42).
HttpBlob<B>
HttpBody
A wrapper for multiple types of data body.
HttpCache
A cache for HttpClient. Request originated from this cache are stored in memory.
HttpCall<R>
Represents a simple HTTP call that can be called many times.
HttpClient
Mercury HTTP Client.
HttpClientInterceptor
An interceptor that can be used to filter requests and responses.
HttpClientRequester
Abstract HttpClient requester. This should implement the actual request process.
HttpClientRequesterSimulation
A Simulated HttpClientRequester. Useful for tests and mocks.
HttpError
Represents a response Error.
HTTPOutputInterceptorWrapper<E>
HttpRequest
Represents the HTTP request.
HttpRequestBody
Represents a body content, used by HttpRequest.
HttpRequester
A Class able to do a HTTP request based in properties:
HttpResponse
The response of a HttpRequest.
HttpStatus
Represents a HTTP Status with helpers. Base for HttpResponse and HttpError.
ImageClip
Represents an image clip parameters.
ImageFileReader
ImagePerspectiveFilter
A filter that applies a perspective to an image.
ImagePerspectiveFilterCache
A cache for perspective filers.
ImageScaledCache
A cache for scaled images.
InputConfig
Configuration for an input.
INPUTElement
InteractionCompleter
Tracks interactions and after a delay, without interaction, triggers onComplete.
InteractionCompleterDummy
A dummy version of InteractionCompleter.
JSONBodyCredential
A Credential that injects a JSON in the HttpRequest body.
JSONConfig
JSONConfigDocument
JSONObject
Base class for an Object that can be converted to JSON.
JSONPaging
Generic representation of a paging result in JSON.
JSONTransformer
Label<T extends num>
ListenerWrapper<T>
Wraps Stream listen call.
LoadController
Controls a load process.
MapDelegate<K, V>
A Map that delegates to another _map. Useful to extend Map features.
MapProperties
A Map of properties.
MasonryItem
Math
Common mathematical functions and constants.
MimeType
Represents MIME-Type. Useful for Content-Type and file handling.
MultiStreamController<T>
An enhanced stream controller provided by Stream.multi.
Represents a navigation (route + parameters).
NNField<T>
A field that can't be null. If a null value is set to it, a default value will be used.
ObjectCache
A simple cache of objects, where is possible to define different instantiators for each key.
OPTIONElement
Pair<T>
Represents a pair with a and b of type T.
Parameter<A>
Parameters2<A, B>
Parameters3<A, B, C>
Parameters4<A, B, C, D>
PopupGroup
QueryStringCredential
A Credential that injects fields in the Query parameters.
RegExpDialect
Represents a dialect. Compiles it on construction.
ResourceConfig<D extends ConfigDocument>
ResourceContent
Represents a Resource Content
ResourceContentCache
A cache for ResourceContent.
Scale<T>
Represents a scale with minimum, maximum and length.
ScaleNum<N extends num>
Version of Scale but for num values.
SELECTElement
SpringBootPaging
Implementation for Spring Boot.
State
A state stored in DataStorage.
StorageValue
Represents a value stored in State.
Stream<T>
A source of asynchronous data events.
StreamConsumer<S>
Abstract interface for a "sink" accepting multiple entire streams.
StreamController<T>
A controller with the stream it controls.
StreamIterator<T>
An Iterator-like interface for the values of a Stream.
StreamSink<S>
A object that accepts stream events both synchronously and asynchronously.
StreamSubscription<T>
A subscription on events from a Stream.
StreamTransformer<S, T>
Transforms a Stream.
StreamTransformerBase<S, T>
Base class for implementing StreamTransformer.
StreamView<T>
Stream wrapper that only exposes the Stream interface.
StyleColor
Specifies a CSS color.
SynchronousStreamController<T>
A stream controller that delivers its events synchronously.
TABLEElement
TABLENode
TAsList
TAsMap
TAsString
Converts JSON node to a String.
TBODYElement
TConcatenation
Concatenate transformations
TDecodeJSON
Converts JSON node decoding to a JSON tree.
TDElement
TemplateNode
Represents a template node in DOM.
TEncodeJSON
Converts JSON node encoding to a JSON String.
TEXTAREAElement
TextNode
Represents a text node in DOM.
TextProvider
TextStyle
Specifies a CSS text style.
TFOOTElement
THEADElement
THElement
Timer
A countdown timer that can be configured to fire once or repeatedly.
TListValue
Transforms JSON node to a List index value.
TLowerCase
Converts JSON node to a Lower Case String.
TMapEntry
Converts JSON node to a MapEntry.
TMapValue
Transforms JSON node to a Map key value.
TOperation
Base class for operations.
TrackElementInViewport
Tracks a DOM Element to identify when its visible in viewport.
TrackElementResize
Tracks a DOM Element to identify when its size changes.
TrackElementValue
Tracks a DOM Element to identify when a value changes.
TreeReferenceMap<K, V>
A Map that keeps keys that are in the tree of root.
TRowElement
TSplit
Converts JSON node, splitting to a List<String>.
TString
A text String.
TTrim
Converts JSON node to a Trimmed String.
TUpperCase
Converts JSON node to an Upper Case String.
UIAsyncContent
An asynchronous content.
UIButton
A simple button implementation.
UIButtonBase
Base class for button components.
UIButtonCapture
A generic capture button. See UICapture.
UIButtonCapturePhoto
A Button that captures a photo. See UICapture.
UIButtonLoader
UICalendar
A calendar component.
UICalendarPopup
A button component that shows an UICalendar dialog when clicked.
UICapture
Base class for capture components. See UIButtonCapture and UIButtonCapturePhoto.
UIClipImage
Component to clip an image.
UIColorPicker
UIColorPickerInput
UIComponent
Base class to create Bones_UI components.
UIComponentAsync
A component that renders a content asynchronously.
UIComponentAttributeHandler<C extends UIComponent, T>
Handler of a UIComponent attribute.
UIComponentDOMContext
UIComponentGenerator<C extends UIComponent>
A generator of UIComponent based in a HTML tag, for dom_builder (extends ElementGenerator).
UIConsole
A console output int the UI.
UIControlledComponent
UIDataSource
UIDeviceOrientation
Tracks and fires events of device orientation changes.
UIDialog
UIDialogAlert
UIDialogBase
Component that renders a dialog.
UIDialogEditImage
An UIDialog that edits an image.
UIDialogInput
UIDialogLoading
UIDocument
An UIComponentAsync to show rendered documents, like markdown, html, json and text.
UIDOMActionExecutor
UIDOMGenerator
A DOMGenerator (from package dom_builder) able to generate UIElement (from dart:html).
UIEventHandler
UIExplorer
UIField<V>
For a UIComponent that is a field (has a value).
UIFieldMap<V>
For a UIComponent that is a field with a Map value.
UIInfosTable
Component that renders a table with information.
UIInputTable
Component that renders a table with inputs.
UILoading
UILoadingConfig
UIMasonry
UIMenu
UIMultiSelection
A component that renders a multi-selection input.
UINavigableComponent
Bones_UI base class for navigable components using routes.
UINavigableContent
A Bones_UI component for navigable contents by routes.
UINavigator
Handles navigation and routes.
UIPopupMenu
UIRoot
The root for Bones_UI component tree.
UISVG
Component to show a SVG.
UniqueCaller<R>
Ensures that a call is executed only 1 per time.
URLFileReader
Represents an url link, with an optional target.
VideoFileReader
ViewerElement<T>
Represents an element in the CanvasImageViewer.
Viewport
Represents browser window Viewport.
YAMLConfig
YAMLConfigDocument
Zone
A zone represents an environment that remains stable across asynchronous calls.
ZoneDelegate
An adapted view of the parent zone.
ZoneSpecification
A parameter object with custom zone function handlers for Zone.fork.

Enums

CalcOperation
CalendarMode
CaptureDataFormat
The internal representation of the captured data. It's recommended to use the target format for your case, to avoid data duplication and data conversion.
CaptureType
The capture type of an UICapture.
ControllerPropertiesType
CSSBackgroundAttachment
CSSBackgroundBox
CSSBackgroundRepeat
CSSBorderStyle
CSSUnit
The CSS numeric units.
DataSourceOperation
Enum for type of DataSource operation.
DataStorageType
Type of DataStorage.
DateRangeType
Enum for types of date ranges.
DateTimeWeekDay
Represents a Week day.
DOMTemplateCmp
DynCallType
EditionType
The type of edition for CanvasImageViewer.
FontStyle
Specifies a CSS font style.
FontWeight
Specifies a CSS font weight.
HttpMethod
HTTP Method
OnHttpErrorAnswer
Specify an HTTP error.
PopupPosition
Quality
Quality of an image.
StateOperation
State operation.
TouchDeviceDetection
Status type of touch device detection.
UIComponentClearParent
UIComponent behavior to clear the component.
UILoadingType
Unit

Mixins

WithValue

Extensions

CalendarModeExtension on CalendarMode
DomElementExtension on Element
DSXFutureExtension on Future<T>
DSX extensions for Future.
DSXFutureOrExtension on FutureOr<T>
DSX extensions for FutureOr.
ElementExtension on UIElement
FutureExtensions on Future<T>
Convenience methods on futures.
FutureIterable on Iterable<Future<T>>
FutureRecord2 on (Future<T1>, Future<T2>)
Parallel operations on a record of futures.
FutureRecord3 on (Future<T1>, Future<T2>, Future<T3>)
Parallel operations on a record of futures.
FutureRecord4 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>)
Parallel operations on a record of futures.
FutureRecord5 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>)
Parallel operations on a record of futures.
FutureRecord6 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>)
Parallel operations on a record of futures.
FutureRecord7 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>)
Parallel operations on a record of futures.
FutureRecord8 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>)
Parallel operations on a record of futures.
FutureRecord9 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>, Future<T9>)
Parallel operations on a record of futures.
IterableDomElementExtension on Iterable<E>
IterableElementExtension on Iterable<E>
SelectElementExtension on SelectElement

Constants

codeTheme0 → const Map<String, TextStyle>
codeTheme1 → const Map<String, TextStyle>
codeTheme2 → const Map<String, TextStyle>
cssMaxZIndex → const int
oneDay → const int
oneHour → const int
oneMinute → const int
oneSecond → const int

Properties

ARGUMENT_LIST_DELIMITER RegExp
final
codeTheme CSSThemeSet
final
CSS_LIST_DELIMITER RegExp
final
DEFAULT_DATA_SOURCE_BASE_URL String?
getter/setter pair
deviceHeight int?
no setter
deviceWidth int?
no setter
isExtraLargeDevice bool
no setter
isExtraSmallDevice bool
no setter
isLargeDevice bool
no setter
isLargeDeviceOrHigher bool
no setter
isLargeDeviceOrLower bool
no setter
isMediumDevice bool
no setter
isMediumDeviceOrLHigher bool
no setter
isMediumDeviceOrLower bool
no setter
isSmallDevice bool
no setter
isSmallDeviceOrHigher bool
no setter
isSmallDeviceOrLower bool
no setter
logger → _Logger
final
onDetectTouchDevice EventStream<TouchDeviceDetection>
Will fire a TouchDeviceDetection when detection finishes.
final
regExpEmail RegExp
final
STRING_LIST_DELIMITER RegExp
final
stringPlaceholderPattern RegExp
final

Functions

$a({Object? id, Object? classes, Object? style, Map<String, String>? attributes, String? href, String? target, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates an a node.
$asyncContent({Object? loading, Future? future, Future function()?}) DOMAsync
Creates a div node with display: inline-block.
$br({int amount = 1, bool commented = false}) DOMElement
Creates a br node.
$button({Object? id, Object? name, Object? classes, Object? style, String? type, Map<String, dynamic>? attributes, Object? content, bool? hidden, bool disabled = false, bool commented = false}) DOMElement
Creates a button node.
$caption({Object? id, Object? classes, Object? style, String? captionSide, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) CAPTIONElement
Creates a caption node.
$checkbox({Object? id, Object? name, Object? classes, Object? style, Object? placeholder, Map<String, String>? attributes, bool? checked, Object? value, bool? hidden, bool disabled = false, bool commented = false}) CHECKBOXElement
Creates an input node of type checkbox.
$div({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DIVElement
Creates a div node.
$divCenteredContent({Object? classes, String? style, String width = '100%', String height = '100%', String? cellsClasses, String? cellsStyle, String? cellSpacing, int? cellsPerRow, List? cells, List? rows, Object? content}) DIVElement
Creates a div that centers vertically and horizontally using display table and table-cell.
$divHTML(Object? html) DIVElement?
Creates a div node from HTML.
$divInline({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DIVElement
Creates a div node with display: inline-block.
$dsx(dynamic o) List<DOMNode>
Parses o to a List<DOMNode>, resolving DSX objects.
$dsxCall(Function f, [dynamic a1, dynamic a2, dynamic a3, dynamic a4, dynamic a5, dynamic a6, dynamic a7, dynamic a8, dynamic a9, dynamic a10]) DSX
Converts a call to f to a DSX object.
$footer({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a footer node.
$form({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a form node.
$header({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a header node.
$hr({Object? id, Object? classes, Object? style, Map<String, String>? attributes, bool? hidden, bool commented = false}) DOMElement
Creates a hr node.
$html<T extends DOMNode>(Object? html) List<DOMNode>
Returns a list of nodes from html.
$htmlRoot(Object? html, {String? defaultRootTag, bool? defaultTagDisplayInlineBlock}) DOMElement?
$img({Object? id, Object? classes, Object? style, Map<String, String>? attributes, String? src, Future<String?>? srcFuture, String? title, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates an img node.
$input({Object? id, Object? name, Object? classes, Object? style, Object? type, Object? placeholder, Map<String, String>? attributes, Object? value, bool? hidden, bool disabled = false, bool commented = false}) INPUTElement
Creates an input node.
$label({Object? id, String? forID, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a label node.
$li({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a li node.
$nav({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a nav node.
$nbsp([int length = 1]) String
$ol({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a ol node.
$option({Object? classes, Object? style, Map<String, String>? attributes, Object? value, String? label, bool? selected, bool disabled = false, Object? text, Object? valueAndText}) OPTIONElement
Creates an option node.
$p({Object? id, Object? classes, Object? style, Map<String, String>? attributes, bool? hidden, bool commented = false}) DOMElement
Creates a p node.
$radiobutton({Object? id, Object? name, Object? classes, Object? style, Object? placeholder, Map<String, String>? attributes, Object? value, bool? hidden, bool disabled = false, bool commented = false}) INPUTElement
Creates an input node of type radio.
$select({Object? id, Object? name, Object? classes, Object? style, Map<String, String>? attributes, Object? options, Object? selected, bool? multiple, bool? hidden, bool disabled = false, bool commented = false}) SELECTElement
Creates an select node.
$span({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a span node.
$table({Object? id, Object? classes, Object? style, Object? thsStyle, Object? tdsStyle, Object? trsStyle, Map<String, String>? attributes, Object? caption, Object? head, Object? body, Object? foot, bool? hidden, bool commented = false}) TABLEElement
Creates a table node.
$tag(String tag, {Object? id, Object? classes, Object? style, Map<String, dynamic>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a node with tag.
$tagHTML<T extends DOMElement>(Object? html) → T?
Creates a tag node from html.
$tags<T>(String tag, Iterable<T>? iterable, [ContentGenerator<T>? elementGenerator]) List<DOMElement>
Creates a list of nodes of same tag.
$tbody({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? rows, bool? hidden, bool commented = false}) TBODYElement
Creates a tbody node.
$td({Object? id, Object? classes, Object? style, Map<String, String>? attributes, int? colspan, int? rowspan, String? headers, Object? content, bool? hidden, bool commented = false}) TDElement
Creates a td node.
$textarea({Object? id, Object? name, Object? classes, Object? style, Object? cols, Object? rows, Map<String, String>? attributes, Object? content, bool? hidden, bool disabled = false, bool commented = false}) TEXTAREAElement
Creates a textarea node.
$tfoot({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? rows, bool? hidden, bool commented = false}) TFOOTElement
Creates a tfoot node.
$th({Object? id, Object? classes, Object? style, Map<String, String>? attributes, int? colspan, int? rowspan, String? abbr, String? scope, Object? content, bool? hidden, bool commented = false}) THElement
Creates a th node.
$thead({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? rows, bool? hidden, bool commented = false}) THEADElement
Creates a thread node.
$tr({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? cells, bool? hidden, bool commented = false}) TRowElement
Creates a tr node.
$uiButton({dynamic id, String? field, dynamic classes, dynamic style, Map<String, String>? attributes, String? text, bool commented = false}) DOMElement
DOMElement tag ui-button for UIButton.
$uiButtonLoader({dynamic id, String? field, dynamic classes, dynamic style, dynamic buttonClasses, dynamic buttonStyle, Map<String, String>? attributes, dynamic content, bool commented = false, bool? withProgress, dynamic loadingConfig}) DOMElement
DOMElement tag ui-button-loader for UIButtonLoader.
$uiDialog({dynamic id, String? field, dynamic classes, dynamic style, bool? show, bool? showCloseButton, Map<String, String>? attributes, dynamic content, bool commented = false}) DOMElement
DOMElement tag ui-dialog for UIDialog.
$uiLoading({UILoadingType? type, dynamic inline, dynamic color, dynamic zoom, dynamic text, dynamic textZoom, bool? withProgress}) DIVElement
$uiSVG({dynamic id, String? field, dynamic classes, dynamic style, String? src, dynamic width, dynamic height, dynamic color, dynamic title, Map<String, String>? attributes, dynamic content, bool commented = false}) DOMElement
DOMElement tag ui-svg for UISVG.
$ul({Object? id, Object? classes, Object? style, Map<String, String>? attributes, Object? content, bool? hidden, bool commented = false}) DOMElement
Creates a ul node.
$validate<T extends DOMNode>({bool preValidate()?, DOMNodeValidator<T>? validate, T? node, DOMNodeInstantiator<T>? instantiator, bool rethrowErrors = false}) → T?
Validates a DOMNode before return it.
addAllToList(List list, Object? values) → void
Adds all values to list.
addCSSCode(String cssCode) Future<bool>
Adds a CSS code (cssCode) into DOM.
addCssSource(String cssSource, {int? insertIndex}) Future<bool>
Add a CSS path using a link element into head DOM node.
addElementsClasses(Iterable<Element> elements, Iterable<String> classes) bool
Add to elements a set of classes. Will remove classes starting with '!'.
addJavaScriptCode(String scriptCode) Future<bool>
Adds a JavaScript code (scriptCode) into DOM.
addJavaScriptSource(String scriptSource, {bool addToBody = false, bool async = false}) Future<bool>
Adds a JavaScript path (scriptSource] into DOM.
addJSFunction(String name, List<String> parameters, String body) Future<bool>
Adds a JavaScript function into DOM.
animateCSSSequence(Iterable<CSSAnimationConfig> animationsConfig, {Duration? initialDelay, int? repeat, bool? repeatInfinity}) Future<void>?
Sames animateCSS but runs animationsConfig in sequence;
appendElementInnerHTML(Element element, String html, {NodeValidator? validator}) → void
Appends to the inner HTML of element with parsed result of html.
applyCSS(CssStyleDeclaration css, Element element, [List<Element>? extraElements]) bool
Applies css to element and extraElements list if present.
applyPerspective(CanvasImageSource image, List<Point<num>> perspective) FilterResult?
Apply perspective filter to image.
asCssStyleDeclaration(dynamic css) CssStyleDeclaration
Parses dynamic css as CssStyleDeclaration.
asListOfMap(Object? o) List<Map>?
Returns o as a List<Map>. Converts it if needed.
asListOfString(Object? o) List<String>?
Returns o as a List<String>. Converts it if needed.
asMap(Object? o) Map?
Returns o as Map. Converts it if needed.
asMapOfString(Object? o) Map<String, String>?
Returns o as a Map<String,String>. Converts it if needed.
asNodeSelector(Object? selector) NodeSelector?
asTreeOfKeyString(Object? tree) → dynamic
Maps tree:
averageIterable<I, R>(Iterable<num> iterable) num?
Calculate the average value of iterable.
blockHorizontalScrollTraverse(Element element) → void
Blocks a scroll event in the horizontal direction that traverses the element.
blockHorizontalScrollTraverseEvent(Element element, WheelEvent wheelEvent) bool
Blocks a wheelEvent in the horizontal direction that traverses the element.
blockScrollTraverse(Element element) → void
Blocks a scroll event in the vertical and horizontal directions that traverses the element.
blockVerticalScrollTraverse(Element element) → void
Blocks a scroll event in the vertical direction that traverses the element.
blockVerticalScrollTraverseEvent(Element element, WheelEvent wheelEvent) bool
Blocks a wheelEvent in the vertical direction that traverses the element.
buildMetaContent(Map<String, String?> map) String
Builds a meta content from map.
buildStringPattern(String? pattern, Map? parameters, [List<Map?>? extraParameters]) String?
Builds a string using as place holders in the format {{key}} from parameters and extraParameters.
buildUri(String? scheme, String? host, int? port, {String? path, String? path2, String? queryString, String? fragment}) Uri
Builds an Uri with the parameters.
buildURLWithQueryParameters(String url, Map<String, String?> parameters, {bool removeFragment = false}) String
Builds an URL with Query parameters adding the map parameters to current Query parameters.
callAsync(int delayMs, dynamic function()) Future
Calls a function with a delayMs.
callJSFunction(String method, [List? args]) → dynamic
Calls JavaScript a function method with args.
callJSObjectMethod(Object o, String method, [List? args]) → dynamic
Calls JavaScript a method in object o with args.
canBeInDOM(dynamic element) bool
Returns true if element type is able to be in DOM.
canHttpMethodHaveBody(HttpMethod method) bool
canvasToImageElement(CanvasElement canvas, [String? mimeType, num? quality]) ImageElement
Converts canvas to ImageElement
clearSelections() → void
Clears selected text in vieport.
clipNumber<N extends num>(N? n, N min, N max, [N? def]) → N?
Clips a number n into it's limits, min and max.
computeCalcOperationSymbol(CalcOperation op, num a, num b) num
contentTypeToDecoder(MimeType mimeType) Converter<List<int>, String>
Returns de decoder for a Content-Type at parameter mimeType and charset.
copyElementToClipboard(Element element) bool
Copies element text to Clipboard.
copyList(List? list) List?
Copies list.
copyListString(List<String>? list) List<String>?
Copies list as a List<String>.
copyMap(Map? map) Map?
Copies map.
copyMapString(Map<String, String>? m) Map<String, String>?
Copies map as a Map<String,String>.
copyPoints(List<Point<num>> points) List<Point<num>>
Makes a copy of points.
createDiv([bool inline = false, String? html, NodeValidator? validator]) DivElement
Creates a div. inline If true sets display: inline-block. html The HTML to parse as content.
createDivInline([String? html]) DivElement
Creates a div with display: inline-block.
createDivInlineBlock() DivElement
Creates a div with display: inline-block.
createHTML([String? html, NodeValidator? validator]) Element
Creates a HTML Element. Returns 1st node form parsed HTML.
createHttpBlob(List content, MimeType? mimeType) HttpBlob?
createHttpClientRequester() HttpClientRequester
Creates a HttpClientRequester based in imported platform.
createImageElementFromBase64(String? base64, [String? mimeType]) ImageElement?
Creates an image from a Base-64 with mimeType.
createImageElementFromFile(File file) Future<ImageElement>
Creates an image from a file.
createLabel([String? html, NodeValidator? validator]) LabelElement
Creates a label element.
createScaledImage(CanvasImageSource image, int width, int height, double scale) CanvasImageSource
Creates a new image from image, of width and height, to a scale.
createSpan([String? html, NodeValidator? validator]) SpanElement
Creates a span element.
createStandardNodeValidator({bool svg = true, bool allowSvgForeignObject = false}) NodeValidatorBuilder
createTableCaption(Object? caption) CAPTIONElement?
createTableCells(Object? rowCells, [bool header = false]) List<TABLENode>
createTableContent(dynamic content, dynamic caption, dynamic head, dynamic body, dynamic foot, {bool? header, bool? footer}) List
createTableEntry(Object? entry, {bool? header, bool? footer}) TABLENode?
createTableRow(Object? rowCells, [bool? header]) TRowElement
createTableRows(Object? rows, bool header) List<TRowElement>
cropImage(CanvasImageSource image, int x, int y, int width, int height) CanvasElement?
Crops the image using coordinates x, y, width and height, returning new image (CanvasElement).
cropImageByRectangle(CanvasImageSource image, Rectangle<num>? crop) CanvasElement?
Crops an image using a Rectangle (crop), delegating to method cropImage,
dataSizeFormat(int? size, {bool? decimalBase, bool? binaryBase}) String?
Formats size as a data format using binary of decimal base for sufixes.
dataURLToBlob(DataURLBase64 dataURL) Blob
Converts a dataURL to a Blob.
dateFormat_YY_MM([int? time, String delimiter = '-']) String
dateFormat_YY_MM_dd([int? time, String delimiter = '-']) String
dateFormat_YYYY_MM([int? time, String delimiter = '-']) String
dateFormat_YYYY_MM_dd([int? time, String delimiter = '-']) String
dateFormat_YYYY_MM_dd_HH([int? time, String delimiter = '-']) String
dateFormat_YYYY_MM_dd_HH_mm([int? time, String delimiter = '-', String hourDelimiter = ':']) String
dateFormat_YYYY_MM_dd_HH_mm_ss([int? time, String delimiter = '-', String hourDelimiter = ':']) String
decodeQueryString(String? queryString) Map<String, String>
Decodes queryString to a Map<String,String>.
deepCatchesListValues<T>(List? list, ValueFilter filter, [List? result]) List
Catches deeply list values that matches filter.
deepCatchesMapValues<T>(Map? map, ValueFilter filter, [List? result]) List
Catches deeply map values that matches filter.
deepCatchesSetValues<T>(Set? set, ValueFilter filter, [List? result]) List
Catches deeply set values that matches filter.
deepCatchesValues<T>(Object? o, ValueFilter filter, [List? result]) List
Catches deeply values that matches filter.
deepCopy<T>(T? o, {Copier? copier}) → T?
Deeply copies o.
deepCopyList<T>(List<T>? l, {Copier? copier}) List<T>?
Deeply copies list.
deepCopyMap<K, V>(Map<K, V>? map, {Copier? copier}) Map<K, V>?
Deeply copies map.
deepHashCode(Object? o) int
Calculate a hashcode over o, iterating deeply over sub elements if is a List or Map.
deepHashCodeList(List? list) int
Computes a hash code inspecting deeply list.
deepHashCodeMap(Map? map) int
Computes a hash code inspecting deeply map.
deepReplaceListValues<T>(List? list, ValueFilter filter, ValueReplacer replacer) → void
Replaces values applying replacer to values that matches filter.
deepReplaceMapValues<T>(Map? map, ValueFilter filter, ValueReplacer replacer) → void
Replaces values applying replacer to values that matches filter.
deepReplaceSetValues<T>(Set? set, ValueFilter filter, ValueReplacer replacer) → void
Replaces values applying replacer to values that matches filter.
deepReplaceValues<T>(Object? o, ValueFilter filter, ValueReplacer replacer) Object?
Replaces values applying replacer to values that matches filter.
defineCSS(CssStyleDeclaration? currentCSS, CssStyleDeclaration? appendCSS, [dynamic defaultCSS]) CssStyleDeclaration
Defines a new CssStyleDeclaration merging currentCSS and appendCSS.
detectTouchDevice() TouchDeviceDetection?
Starts touch device detection. Returns the current status.
disableDoubleClicks() → void
Disables browser double clicks/tap.
disableScrolling() → void
Disables scrolling in browser.
disableZooming() → void
Disables browser zooming.
doDataSourceOperation<T>(DataSource<T> dataSource, DataSourceOperation operation, Map<String, String>? parameters, [List<T>? dataList]) Future<List<T?>?>
Performs a DataSourceOperation over dataSource instance.
domBuilderLog(String message, {bool warning = false, Object? error, StackTrace? stackTrace}) → void
doTransformFrom<T>(T? data, DataTransformerFrom<T>? transformerFrom) → dynamic
doTransformFromList<T>(List<T>? list, DataTransformerFrom<T>? transformerFrom, DataTransformerFromList<T>? transformerFromList) → dynamic
doTransformTo<T>(Object? o, DataTransformerTo<T>? transformerTo) → T?
doTransformToList<T>(Object? o, DataTransformerTo<T>? transformerTo, DataTransformerToList<T>? transformerToList) List<T>?
downloadBlob(Blob blob, String fileName) → void
Downloads blob of type mimeType, saving a file with fileName.
downloadBytes(List<int> bytes, MimeType mimeType, String fileName) → void
Downloads bytes of type mimeType, saving a file with fileName.
downloadContent(List<String> content, MimeType mimeType, String fileName) → void
Downloads content of type mimeType, saving a file with fileName.
downloadDataURL(DataURLBase64 dataURL, String fileName) → void
Downloads dataURL, saving a file with fileName.
elementMatchesAttribute(Element element, String attributeName, dynamic attributeValue) bool
Returns true if element matches attributeName and attributeValue.
elementMatchesAttributes(Element element, Map<String, dynamic> attributes) bool
Returns true if element matches attributes.
elementOnLoad(ImageElement img) Future<bool>
Returns a Future<bool> for when img loads.
enableScrolling() → void
Enables scrolling in browser.
encodeJSON(Object? json, {String? indent, bool withIndent = false, bool clearNullEntries = false, Object? toEncodable(Object? object) = toEncodableJSON}) String
Encodes json to a JSON string.
encodeQueryString(Map<String, String>? parameters) String
Encodes parameters as a query string.
ensureNotEmptyString(String? s, {bool trim = false, String? def}) String?
If s isEmptyString will return def or null.
evalJS(String scriptCode) → dynamic
Call eval() with the content of scriptCode and returns the result.
fieldEmailValidator(String field, String? value) bool
fieldNormalizerLowerCase(String field, Object? value) Object?
fieldNormalizerTrim(String field, Object? value) Object?
fieldNormalizerUpperCase(String field, Object? value) Object?
fieldURLDataBase64Validator(String field, String? value) bool
fieldURLValidator(String field, String? value) bool
findKeyEntry<K, V>(Map? map, List<K>? keys, [bool ignoreCase = false]) MapEntry<K, V?>?
Finds in map a entry that has one of keys.
findKeyName<K, V>(Map? map, List<K>? keys, [bool ignoreCase = false]) → K?
Finds in map a key that has one of keys.
findKeyPathValue<V>(Map? map, String? keyPath, {String keyDelimiter = '/', bool isValidValue(Object? value)?}) → V?
Finds in map a value that is in key path keyPath
findKeyValue<K, V>(Map? map, List<K>? keys, [bool ignoreCase = false]) → V?
Finds in map a value that has one of keys.
formatDecimal(Object? value, {int precision = 2, String decimalSeparator = '.'}) String?
Formats value to a decimal value.
formatPercent(Object? percent, {int precision = 2, bool isRatio = false}) String
Formats percent as a percentage string like: 0%, 90% or 100%.
formatTimeMillis(int? time) String
getAllCssRuleBySelector(Pattern targetSelector, CssStyleSheet? sheet) List<CssRule>
Returns a List<CssRule> for targetSelector.
getAllCssStyleSheet() List<CssStyleSheet>
Returns all current CssStyleSheet.
getAllMediaCssRule(String mediaCondition) List<CssMediaRule>
Returns a list of @media CssRule with mediaCondition.
getAllOutOfViewportMediaCssRule(int viewportWidth, dynamic viewportHeight) List<CssMediaRule>
Returns all CssMediaRule not applied for viewportWidth and viewportHeight.
getAllOutOfViewportMediaCssRuleAsClassRule(int viewportWidth, dynamic viewportHeight, String targetClass) List<String>
Transforms all CssMediaRule to targetClass rule not applied for viewportWidth and viewportHeight.
getAllViewportMediaCssRule(int viewportWidth, dynamic viewportHeight) List<CssMediaRule>
Returns all CssMediaRule applied for viewportWidth viewportHeight.
getAllViewportMediaCssRuleAsClassRule(int viewportWidth, dynamic viewportHeight, String targetClass) List<String>
Transforms all CssMediaRule to targetClass rule applied for viewportWidth and viewportHeight.
getAnchorElementByHREF(String href) AnchorElement?
Selects an AnchorElement in DOM with href.
getCalcOperation(String? op) CalcOperation?
getCalcOperationSymbol(CalcOperation? op) String?
getCharsetEncoding(String? charset) Encoding?
getComputedStyle({Element? parent, Element? element, String? classes, String? style, bool? hidden}) CssStyleDeclaration
Returns a CssStyleDeclaration from an element.
getCSSBackgroundAttachmentName(CSSBackgroundAttachment? clip) String?
getCSSBackgroundBoxName(CSSBackgroundBox? clip) String?
getCSSBackgroundRepeatName(CSSBackgroundRepeat? repeat) String?
getCSSBorderStyleName(CSSBorderStyle borderStyle) String?
getCSSUnitName(CSSUnit? unit, [CSSUnit? def]) String?
getCurrentTimeMillis() int
Returns the current time in milliseconds since epoch.
getDataSourceOperation(String? name) DataSourceOperation?
Returns a DataSourceOperation by name.
getDataSourceOperationName(DataSourceOperation? operation) String?
getDateAmPm([int? time]) String
getDateHour([int? time]) int
getDateTimeDayEnd([DateTime? time]) DateTime
Returns the end of the day for time.
getDateTimeDayStart([DateTime? time]) DateTime
Returns the start of the day for time.
getDateTimeEndOf(DateTime time, Object? unit, {DateTimeWeekDay? weekFirstDay, String? locale}) DateTime?
Returns the end of a time unit using time as reference.
getDateTimeLastMonth([DateTime? time]) Pair<DateTime>
Returns start and end of last month, before current month, using time as reference.
getDateTimeLastNDays(int nDays, [DateTime? time]) Pair<DateTime>
Returns start and end of last nDays counting from time.
getDateTimeLastWeek([DateTimeWeekDay? weekFirstDay, DateTime? time]) Pair<DateTime>
Returns start and end of last week, before current week, using time as reference.
getDateTimeNow() DateTime
Same as DateTime.now().
getDateTimePreviousMonth(int month, {int? year}) DateTime
Returns start of previous month, using as reference month and year.
getDateTimeRange(DateRangeType rangeType, [DateTime? time, DateTimeWeekDay? weekFirstDay]) Pair<DateTime>
Returns start and end of date range rangeType.
getDateTimeStartOf(DateTime time, Object? unit, {DateTimeWeekDay? weekFirstDay, String? locale}) DateTime?
Returns the start of a time unit using time as reference.
getDateTimeThisMonth([DateTime? time]) Pair<DateTime>
Returns start and end of this month, using time as reference.
getDateTimeThisWeek([DateTimeWeekDay? weekFirstDay, DateTime? now]) Pair<DateTime>
Returns start and end of this week using time as reference.
getDateTimeWeekDay(int? weekDayIndex) DateTimeWeekDay?
Returns enum DateTimeWeekDay by weekDayIndex (from 1 to 7). See getDateTimeWeekDayIndex.
getDateTimeWeekDay_from_ISO_8601_index(int? weekDayIndex) DateTimeWeekDay?
Returns enum DateTimeWeekDay using weekDayIndex compliant with ISO 8601.
getDateTimeWeekDayByName(String? weekDayName) DateTimeWeekDay?
Returns enum DateTimeWeekDay by week day name in english
getDateTimeWeekDayIndex(DateTimeWeekDay? weekDay) int?
Gets index of DateTimeWeekDay, starting from 1 (Monday) to 7 (Sunday), same range as DateTime.wednesday .
getDateTimeWeekEnd([DateTimeWeekDay? weekFirstDay, DateTime? now]) DateTime
Returns the end of the week using time as reference.
getDateTimeWeekStart([DateTimeWeekDay? weekFirstDay, DateTime? time]) DateTime
Returns the start of the week using time as reference.
getDateTimeYesterday([DateTime? time]) DateTime
Returns the start of yesterday from time.
getDOMTemplateCmpOperator(DOMTemplateCmp? cmp) String
getElementAllCssProperties(Element element) List<String>
Returns a list of CSS properties associated with element
getElementAllCssRule(Element element) List<CssRule>
Returns a list of CssRule associated with element.
getElementAttribute(Element element, Object? key) String?
Returns element attribute with key.
getElementAttributeRegExp(Element element, RegExp key) String?
Returns element attribute with RegExp key.
getElementAttributeStr(Element element, String key) String?
Returns element attribute with String key.
getElementByHREF(String tag, String href) Element?
Selects an Element in DOM with tag and href.
getElementBySRC(String tag, String src) Element?
Selects an Element in DOM with tag and src.
getElementByValues<V>(String tag, ElementValueGetter getter, List<V> values, [ElementValueGetter? getter2, List<V>? values2]) Element?
selects in DOM an Element with tag and one of values provided by getter.
getElementDocumentPosition(Element element) Pair<num>
Returns the X and Y position of Element int the Document.
getElementHeight(Element element, [int? def]) int?
Returns element height. Tries to use 'offsetHeight' or 'style.height' values.
getElementHREF(Element element) String?
Returns href value for different Element types.
getElementPreComputedStyle(Element element) CssStyleDeclaration
Returns a CssStyleDeclaration of the pre-computed CSS properties of element.
getElementSRC(Element element) String?
Returns src value for different Element types.
getElementsWithAttributes(String tag, Map<String, dynamic> matchAttributes) List<Element>
Selects elements from DOM with tag and matches attribute.
getElementTagName(Node node) String?
Returns the node tag name. Returns null if node is not an Element.
getElementValue(Element element, [String? def]) String?
Gets the element value depending of identified type.
getElementWidth(Element element, [int? def]) int?
Returns element width. Tries to use 'offsetWidth' or 'style.width' values.
getElementZIndex(Element? element, [String? def]) String?
Returns the element z-index or element.parent z-index recursively.
getEntryIgnoreCase<V>(Map<String, V?> map, String? key) MapEntry<String, V?>?
Gets a map entry ignoring key case.
getFileMimeType(File file, [String accept = '']) MimeType?
Returns the file MimeType.
getHttpClientRuntimeUri() Uri
Returns the base runtime Uri for the platform.
getHttpMethod(String? method, [HttpMethod? def]) HttpMethod?
Returns HttpMethod instance for method parameter.
getHttpMethodName(HttpMethod? method, [HttpMethod? def]) String?
Returns method name.
getIgnoreCase<V>(Map<String, V> map, String? key) → V?
Gets a map value ignoring key case.
getImageDimension(CanvasImageSource image) Rectangle<int>?
Gets the width and height from image (CanvasImageSource).
getLanguageByExtension(String extension) String?
Returns a document language by extension.
getLastDayOfMonth(int month, {int? year}) int
Returns the last day of month.
getLinkElementByHREF(String href, [String? rel]) LinkElement?
Selects an LinkElement in DOM with href.
getMetaTagsContentWithName(String name) List<String?>
Returns a list of meta contet with name.
getMetaTagsWithName(String name) List<Element>
Returns a list of meta Element with name.
getMillisecondsAsUnit(int? ms, Object? unit, [double? def]) double?
getParentElement(Element element, {bool validator(Element parent)?, int maxLevels = 1000}) Element?
Returns the parent of element applying validator and maxLevels.
getPathExtension(String? path) String?
Returns the File extension of a path.
getPathFileName(String? path) String?
Returns the File name of a path.
getPathWithoutFileName(String? path) String?
Returns path removing File name if present.
getScriptElementBySRC(String src) ScriptElement?
Selects an ScriptElement in DOM with src.
getSetEntryInstance<T>(Set<T>? set, T? value) → T?
Returns the instance that matches value in set.
getUILoadingType(dynamic type) UILoadingType?
getUILoadingTypeClass(UILoadingType type) String?
getUnitAsMilliseconds(Object? unit, [int amount = 1]) int
getUnitByIndex(int? index, [Unit? def]) Unit?
getUnitByName(String? name, [Unit? def]) Unit?
getUriBase() Uri
Returns platform base Uri. See Uri.base .
getUriBaseHost() String
The host of base Uri.
getUriBaseHostAndPort({bool suppressPort80 = true, int? port}) String
The host and port of base Uri.
getUriBasePort() int
The port of base Uri.
getUriBaseScheme() String
The scheme of base Uri.
getUriRoot() Uri
The root Uri for the platform.
getUriRootURL({bool suppressPort80 = true, int? port}) String
Returns base Uri as URL string.
getURLData(String url, {String? user, String? password, bool withCredentials = true}) Future<Uint8List>
Makes a HTTP request and returns url content as Uint8List.
getVisibleNode(Element? element) Element?
Get the first visible element in the hierarchy.
getWeekFirstDay([String? locale]) DateTimeWeekDay
Returns the first day of a week as enum DateTimeWeekDay for locale.
groupIterableBy<K, V, I>(Iterable<I> iterable, MapEntry<K, V> map(I entry), V merge(K key, V value1, V value2)) Map<K, V>
Groups interable entries using map to generate a MapEntry for each entry, than uses merge to group entries of the same group (key).
hasBlankChar(String s) bool
Returns true if s has a blank character.
hasBlankCharFrom(String s, [int offset = 0]) bool
Returns true if s has a blank character from offset.
hasBlankCharInRange(String s, int offset, int length) bool
Returns true if s has a blank character in range offset+length.
hasHTMLEntity(String s) bool
hasHTMLTag(String s) bool
htmlAsSvgContent(String html, {int? width, int? height, String? rootClass, String? style}) String?
htmlToText(String html, [NodeValidator? validator]) String?
Transform html to plain text.
isAllEquals(Object? element, Object? value, [bool deep = false]) bool
Returns true element is equals to value.
isAllEqualsInList(List? list, Object value, [bool deep = false]) bool
Returns true if list elements are all equals to value.
isAllEqualsInMap(Map? map, Object value, [bool deep = false]) bool
Returns true if map values are all equals to value.
isAlphaNumeric(int c) bool
isAlphaNumericString(String s, [int offset = 0]) bool
isAlphaNumericStringInRange(String s, int offset, int length) bool
isBlankChar(String? c) bool
Returns true if c is a blank char (space, \t, \n, \r).
isBlankCodeUnit(int c) bool
Returns true if c is a blank char code unit.
isBlankString(String s, [int offset = 0]) bool
Returns true if s has only blank characters.
isBlankStringInRange(String s, int offset, int length) bool
Returns true if s has only blank characters in range offset+length.
isBool(Object? value) bool
Returns true if value is bool. Can be a bool as string too.
isBoolList(Object? value, [String delimiter = ',']) bool
Returns true if is a list of bool. Can be a string of bool too.
isComponentInDOM(dynamic element) bool
Returns true if a Bones_UI component is in DOM.
isCssEmpty(CssStyleDeclaration css) bool
Returns true if CssStyleDeclaration is empty.
isCssNotEmpty(CssStyleDeclaration css) bool
Returns true if CssStyleDeclaration is not empty.
isCSSViewportUnit(CSSUnit unit) bool
isDigit(int c) bool
isDigitString(String s, [int offset = 0]) bool
isDigitStringInRange(String s, int offset, int length) bool
isDOMBuilderDirectHelper(Object? f) bool
Returns true if f is a DOM Builder helper, like $div and $br.
isDouble(Object? value) bool
Returns true if value is double. Can be a double as string too.
isDoubleList(Object? value, [String delimiter = ',']) bool
Returns true if is a list of double. Can be a string of double too.
isElementWithHREF(Element element) bool
Returns true if element type can have href attribute.
isElementWithSRC(Element element) bool
Returns true if element type can have src attribute.
isEmail(Object? value) bool
Returns true if value represents an e-mail address.
isEmptyObject<T>(T? o, {bool trim = false}) bool
Returns true if o is empty. Checks for String, List, Map Iterable, Set or o.toString().
isEmptyString(String? s, {bool trim = false}) bool
Returns true if s is empty or null.
isEncodedJSON(String? s) bool
Returns true if s is a encoded JSON String of a primitive value.
isEncodedJSONBoolean(String? s) bool
Returns true if s is a encoded JSON bool.
isEncodedJSONList(String? s) bool
Returns true if s is a encoded JSON List.
isEncodedJSONMap(String? s) bool
Returns true if s is a encoded JSON Map.
isEncodedJSONNull(String? s) bool
Returns true if s is a encoded JSON null.
isEncodedJSONNumber(String? s) bool
Returns true if s is a encoded JSON num.
isEncodedJSONPrimitive(String? s) bool
Returns true if s is a encoded JSON String of a primitive value.
isEncodedJSONString(String? s) bool
Returns true if s is a encoded JSON String.
isEquals(Object? o1, Object? o2, [bool deep = false]) bool
Returns true if o1 and o2 are equals.
isEqualsAsString(Object? o1, Object? o2) bool
Returns true if o1 and o2 are equals as String. Uses String.toString to check.
isEqualsDeep(Object? o1, Object? o2) bool
Returns true if o1 and o2 are equals deeply.
isEqualsIterable<T>(Iterable<T>? i1, Iterable<T>? i2) bool
Returns true if both iterable, i1 and i2, have equals entries in the same order.
isEqualsList<T>(List<T>? l1, List<T>? l2) bool
Returns true if both lists, l1 and l2, have equals entries in the same order.
isEqualsMap<K, V>(Map<K, V>? m1, Map<K, V>? m2) bool
Returns true if both maps, m1 and m2, have equals entries in the same order.
isEqualsSet<T>(Set<T>? s1, Set<T>? s2) bool
Returns true if both sets, s1 and s2, have equals entries in the same order.
isEquivalentIterator(Iterable? it1, Iterable? it2, {bool deep = false}) bool
Same as isEquivalentList but for Iterable.
isEquivalentList(List? l1, List? l2, {bool sort = false, bool deep = false}) bool
Returns true if l1 and l2 are equals, including the same position for the elements.
isEquivalentMap(Map? m1, Map? m2, {bool deep = false}) bool
Returns true if m1 and m2 are equals.
isHTMLElement(String s) bool
isHttpBlob(Object o) bool
isHttpURL(dynamic value) bool
Returns true if value represents a HTTP or HTTPS URL.
isInDOM(dynamic element) bool
Returns true if element is in DOM tree.
isInlineElement(DivElement element, {bool checkBootstrapClasses = true}) bool
Returns true if element display property is inline.
isInt(Object? value) bool
Returns true if value is int. Can be a int as string too.
isIntList(Object? value, [String delimiter = ',']) bool
Returns true if is a list of int. Can be a string of int too.
isInUnixEpochRange(Object? value, [bool inMilliseconds = true]) bool
Returns true if n is in range of a Unix epoch time.
isInViewport(Element element, {bool fully = false}) bool
Returns true if element is visible in viewport.
isIPAddress(String? host) bool
Returns true if is a IPv4 or IPv6 address.
isIPv4Address(String? host) bool
Returns true if is a IPv4 address.
isIPv6Address(String? host) bool
Returns true if is a IPv6 address.
isJSON(Object? value) bool
Returns true if value is a JSON.
isJSONList(Object? json) bool
Returns true if value is a JSON List.
isJSONMap(Object? json) bool
Returns true if value is a JSON Map<String,?>.
isJSONPrimitive(Object? value) bool
Returns true if value is a JSON primitive (String, bool, num, int, double, or null).
isListEntriesAllOfSameType(Iterable? list) bool
Returns true if all list elements are of the same type.
isListEntriesAllOfType(Iterable? list, Type type) bool
Returns true if all list elements are of type.
isListOfList(Object? list) bool
Returns true if list elements are all of type List.
isListOfListOfList(Object? list) bool
Returns true if list elements are all of type List<List>.
isListOfListValuesAllEquals(Iterable<List>? list, {Object? eqValue, int? eqValueIndex}) bool
Returns true if list elements are all equals to value at index valueIndex.
isListOfMap(Object? list) bool
Returns true if list elements are all of type Map.
isListOfNum(Iterable? list) bool
Returns true if list elements are all of type num.
isListOfString(Iterable? list) bool
Returns true if list elements are all of type String.
isListOfStrings(Iterable? list) bool
Returns true if list values are of type String.
isListOfType<T>(Iterable? list) bool
Returns true if list elements are all of type T.
isListOfTypes<A, B>(Iterable? list) bool
Returns true if list elements are all of type A or B.
isListValuesAllEquals(Object? list, [Object? eqValue]) bool
Returns true if list elements are all equals to value.
isListValuesIdentical(List? l1, List? l2) bool
Returns true if all list elements are identical.
isLocalhost(String? host) bool
Returns true if host is localhost (also checks for IPv4 and IPv6 addresses).
isMapOfString(Map? map) bool
Returns true if map is Map<String,String>.
isMapOfStringKeys(Map? map) bool
Returns true if map has String keys.
isMapOfStringKeysAndListValues(Map? map) bool
Returns true if map has String keys and List values.
isMapOfStringKeysAndNumValues(Map? map) bool
Returns true if map has String keys and num values.
isMobileAppStatusBarTranslucent() bool
Returns true if meta tag of name apple-mobile-web-app-status-bar-style is translucent.
isNegativeNumber(num? n) bool
Returns true if n < 0. If n is null returns false.
isNodeInDOM(Node node) bool
Returns true if node is in DOM tree.
isNonBlankChar(String? c) bool
Returns ![isBlankChar].
isNotBlankCodeUnit(int c) bool
Returns ![isBlankCodeUnit].
isNotEmptyObject<T>(T? value, {bool trim = false}) bool
Returns ![isEmptyObject].
isNotEmptyString(String? s, {bool trim = false}) bool
Returns ![isEmptyString].
isNum(Object? value) bool
Returns true if value is num. Can be a num as string too.
isNumList(Object? value, [String delimiter = ',']) bool
Returns true if is a list of num. Can be a string of num too.
isOrientationInLandscapeMode() bool
Returns true if device orientation is in Landscape mode.
isOrientationInPortraitMode() bool
Returns true if device orientation is in Portrait mode.
isPositiveNumber(num? n) bool
Returns true if n > 0. If n is null returns false.
isSafariIOS() bool
isUriBaseIP() bool
isUriBaseLocalhost() bool
Returns true if base Uri is localhost. See isLocalhost.
joinLists(List? l1, [List? l2, List? l3, List? l4, List? l5, List? l6, List? l7, List? l8, List? l9]) List
Joins all parameters to a single list.
jsArrayToList(JsArray? a) List?
Converts a JsArray a to a List. Also converts values using jsToDart.
jsObjectKeys(JsObject o) List<String>
Returns the keys of JsObject o.
jsObjectToMap(JsObject? o) Map?
Converts a JsObject o to a Map. Also converts keys and values using jsToDart.
jsToDart(Object? o) Object?
Converts o to Dart primitives or collections.
lerpDouble(num a, num b, double t) double?
listContainsAll(Iterable? list, Iterable? entries) bool
Returns true if list contains all elements of type entry.
listContainsType<T>(Iterable? list) bool
Returns true if list contains elements of type T.
listenStreamWithInteractionCompleter<T>(Stream<T> stream, Duration triggerDelay, void onData(T? event)) InteractionCompleter
Listen stream, calling onData only after triggerDelay duration.
listMatchesAll<T>(Iterable<T>? list, bool matcher(T entry)) bool
Returns true if all list elements matches matcher.
listMatchesAny<T>(Iterable<T>? list, bool matcher(T entry)) bool
Returns true if any element of list matches matcher.
listNotMatchesAll<T>(Iterable<T>? list, bool matcher(T entry)) bool
Returns true if at least ONE list element does NOT matches matcher.
loadCSS(String cssClassPrefix, Map<String, CSSValueBase>? css) → void
Loads css dynamically.
mapJSFunction(String jsFunctionName, MappedFunction f) → void
Maps a JavaScript function to a Dart function.
markdownToDiv(String markdown, {bool normalize = true, Iterable<BlockSyntax>? blockSyntaxes, Iterable<InlineSyntax>? inlineSyntaxes, ExtensionSet? extensionSet, Resolver? linkResolver, Resolver? imageLinkResolver, bool inlineOnly = false}) DivElement
Converts a markdown document into a HTML in a div node.
markdownToHtml(String markdown, {bool normalize = true, Iterable<BlockSyntax>? blockSyntaxes, Iterable<InlineSyntax>? inlineSyntaxes, ExtensionSet? extensionSet, Resolver? linkResolver, Resolver? imageLinkResolver, bool inlineOnly = false}) String
Converts a markdown document into a HTML string.
maxInIterable<I, R>(Iterable<num> iterable) num?
Uses mergeIterable to find maximum value in iterable.
measureText(String text, {required String fontFamily, required Object fontSize, bool bold = false}) Dimension?
mergeIterable<I, R>(Iterable<I> iterable, R merge(R? total, I value), [R? init]) → R?
Merges all entries of iterable using merge function.
methodAcceptsQueryString(HttpMethod method) bool
minInIterable<I, R>(Iterable<num> iterable) num?
Uses mergeIterable to find minimum value in iterable.
nodeTreeContains(Node rootNode, Node target) bool
Returns true if rootNode contains target.
nodeTreeContainsAny(Node rootNode, Iterable<Node> list) bool
Returns true if rootNode contains any Node in list.
normalizeIndent(String text) String
Normalizes a indent, removing the common/global indent of the code.
numsToPoints(List<num> perspective) List<Point<num>>
Converts a List<num>, as pairs, to a List<Point>.
onOrientationchange(EventListener listener) bool
Attaches listener to orientationchange event.
parseBool(Object? v, [bool? def]) bool?
Parses v to bool.
parseBoolsFromInlineList(Object? s, Pattern delimiter, [List<bool>? def]) List<bool>?
Parses s to a List<bool>.
parseBUIAttribute(String? buiCode, String attributeName) String?
parseComparable<T>(Object? v) Comparable<T>?
Parses v as to a Comparable type.
parseCSSBackgroundAttachment(String attachment) CSSBackgroundAttachment?
parseCSSBackgroundBox(String clip) CSSBackgroundBox?
parseCSSBackgroundRepeat(String repeat) CSSBackgroundRepeat?
parseCSSBorderStyle(String? borderStyle) CSSBorderStyle?
parseCSSLength(String cssValue, {String? unit, int? def, bool allowPXWithoutSuffix = false}) num?
Parses a CSS length, using optional unit.
parseCssRuleSelectors(CssRule cssRule) List<String>
Parses the selectors of cssRule.
parseCssRuleTextProperties(String? cssRuleText) String
Returns a list of properties of the CssRule text.
parseCssRuleTextSelectors(String? cssRuleText) List<String>
Returns a list of selectors of the CssRule text.
parseCSSUnit(String? unit, [CSSUnit? def]) CSSUnit?
parseDateTime(Object? date, [DateTime? def]) DateTime?
Parses date as DateTime.
parseDateTimeFromInlineList(Object? o, [Pattern delimiter = ',', List<DateTime>? def]) List<DateTime>?
Converts o to a List<DateTime>.
parseDOMTemplateCmp(Object? cmp) DOMTemplateCmp?
parseDouble(Object? v, [double? def]) double?
Parses v to double.
parseDoublesFromInlineList(Object? s, [Pattern delimiter = ',', List<double>? def]) List<double>?
Parses s to a List<double>.
parseDuration(String? unit, [int amount = 0, Duration? def]) Duration?
Parses unit and amount to Duration.
parseFromInlineList<T>(String? s, Pattern delimiter, [StringMapper<T>? mapper, List<T>? def]) List<T>?
Parses s as a inline list.
parseFromInlineMap<K, V>(String? s, Pattern delimiterPairs, Pattern delimiterKeyValue, [StringMapper<K>? mapperKey, StringMapper<V>? mapperValue, Map<K, V>? def]) Map<K, V>?
Parses s as a inline Map.
parseFromInlineProperties(String s, [StringMapper<String>? mapperKey, StringMapper<String>? mapperValue, Map<String, String>? def]) Map<String, String>?
Parses an inline properties, like inline CSS, to a Map<String,String>.
parseHTML(String? html) List<DOMNode>?
Parses a html to nodes.
parseInt(Object? v, [int? def]) int?
Parses v to int.
parseIntList(Object? l, [List<int>? def]) List<int>?
Parses l as List<int>.
parseIntsFromInlineList(Object? s, [Pattern delimiter = ',', List<int>? def]) List<int>?
Parses s to a List<int>.
parseJSON(Object? json, [Object? def]) → dynamic
Parses json to a JSON tree.
parseListOf<T, R>(Object? s, ParserFunction<T, R> parser, [List<R>? def]) List<R>?
Parses s to a List<R>, where R is the result of parse.
parseListOfList<T, R>(Object? s, ParserFunction<T, R> parser, [List<List<R>>? def]) List<List<R>>?
Parses s to a List<List<R>>, where R is the result of parse.
parseListOfStrings(Object? s, Pattern delimiter, [bool trim = true]) List<String>
Parses s as a flat List<String>.
parseMapEntryOfStrings<K, V>(Object? e, [Pattern? delimiter, MapEntry<String, String>? def]) MapEntry<String, String>?
Parses e as a MapEntry<String, String>
parseMetaContent(String content) Map<String, String?>
Parses a meta content to Map<String,String>.
parseNum(Object? v, [num? def]) num?
Parses v to num.
parseNumsFromInlineList(Object? s, [Pattern delimiter = ',', List<num>? def]) List<num>?
Parses s to a List<num>.
parseNumsFromList(List list) List<num>
Parses a generic list to a List<num>.
parsePercent(Object? v, [double? def]) num?
Parses v as a percentage from 0..100.
parsePoint(Object? value) Point<num>?
Parses value as a Point.
parsePointFromList(List? list) Point<num>?
Parses list as a Point.
parsePointFromMap(Map map) Point<num>?
Parses map as a Point.
parsePointFromString(String? s) Point<num>?
Parses s as a Point.
parseRectangle(Object? value) Rectangle<num>?
Parses value as a Rectangle.
parseRectangleFromList(List list) Rectangle<num>?
Parses list as a Rectangle.
parseRectangleFromMap(Map<String, Object>? map) Rectangle<num>?
Parses map as a Rectangle.
parseRectangleFromString(String? s) Rectangle<num>?
Parses s as a Rectangle.
parseRegExp(Object? regExp) RegExp?
Parses regExp parameter to RegExp.
parseString(Object? v, [String? def]) String?
Parses v as String.
parseStringFromInlineList(Object? s, [Pattern? delimiter, List<String>? def]) List<String>?
Parses s as inline List<String>.
parseStringFromInlineMap(Object? s, Pattern delimiterPairs, Pattern delimiterKeyValue, [Map<String, String>? def]) Map<String, String>?
Parses s as a inline Map<String,String>.
parseUnit(Object? unit, [Unit? def]) Unit?
possiblyWithHTML(String? s) bool
prefetchHref(String href, {int? insertIndex, bool? preLoad}) Future<bool>
Prefetch a HREF using a link element into head DOM node.
putIgnoreCase<V>(Map<String, V> map, String key, V value) → V?
Puts a map value ignoring key case.
readFileDataAsArrayBuffer(File file) Future<Uint8List?>
Reads file as Uint8List.
readFileDataAsBase64(File file) Future<String?>
Reads file as Base64 String.
readFileDataAsDataURLBase64(File file, [String accept = '']) Future<String?>
Reads file as DATA URL Base64 String.
readFileDataAsText(File file) Future<String?>
Reads file as text.
readFileInputElementAsArrayBuffer(FileUploadInputElement? input, [bool removeExifFromImage = false]) Future<Uint8List?>
Reads selected file of input as Uint8List.
readFileInputElementAsBase64(FileUploadInputElement? input, [bool removeExifFromImage = false]) Future<String?>
Reads selected file of input as Base64.
readFileInputElementAsDataURLBase64(FileUploadInputElement? input, [bool removeExifFromImage = false]) Future<String?>
Reads selected file of input as DATA URL Base64.
readFileInputElementAsString(FileUploadInputElement? input, [bool removeExifFromImage = false]) Future<String?>
Reads selected file of input as String.
redirectOnTouchEndToMouseEvent(Element element) → void
Redirects element.onTouchEnd to element.onMouseUp as MouseEvent.
redirectOnTouchMoveToMouseEvent(Element element) → void
Redirects element.onTouchMove to element.onMouseMove as MouseEvent.
redirectOnTouchStartToMouseEvent(Element element) → void
Redirects element.onTouchStart to element.onMouseDown as MouseEvent.
regExpDialect(Map<String, String> dialectWords, String pattern, {bool multiLine = false, bool caseSensitive = true}) RegExp
Builds a RegExp using a dialect of words (Map parameter dialectWords).
regExpHasMatch(Object? regExp, String s) bool
Returns true if regExp has any match at s.
regExpReplaceAll(Object? regExp, String s, String replace) String
Uses regExp to replace matches at s, substituting with replace.
regExpReplaceAllMapped(Object? regExp, String s, String replace(Match match)) String
Uses regExp to replace matches at s, substituting with replace Function results.
reloadAssets(Map<String, String> assetsURLAndTag, {Duration? timeout}) Future<bool>
Reloads an asset (img, audi or video), forcing reload of asset URL.
reloadIframe(IFrameElement iFrame, [bool? forceGet]) Future<bool>
Reloads an IFrame document.
removeElementBackgroundBlur(Element element, [int? blurSize]) → void
Removes element background blur effect, set by setElementBackgroundBlur.
removeElementScrollColors(Element element) List<String>?
Removes element scroll colors CSS properties set by setElementScrollColors.
removeEmptyEntries(List? list) bool
Remove all entries of list that are true for isEmptyObject.
removeExifFromImageFile(File file) Future<String?>
Removes Exif from JPEG file.
removeNullEntries<T>(T? json) → T?
Remove null entries from json tree.
removeUriFragment(String url) Uri
Removes fragment from url and returns an Uri.
removeUriQueryString(String url) Uri
Removes query string from url and returns an Uri.
replaceElement(Node n1, Node n2) bool
Replaces n1 with n2 in n1 parent.
replaceStringMarks(String? s, RegExp marksPattern, String markResolver(String markName)) String?
Replaces String s marks using marksPattern and markResolver.
resetZoom() → void
Resets viewport zoom.
resolveDataSourceBaseURL(String url) String
resolveUri(String url, {String? baseURL, Uri? baseUri}) Uri
Resolves url and returns an Uri.
resolveURL(String url, {String? baseURL, Uri? baseUri}) String
Same as resolveUri, but returns Uri as URL String.
resolveValue<T>(T? value, [T? def, ValueValidator valueValidator = isNotEmptyObject]) → T?
Validates value and returns value or def.
rotateCanvasImageSource(CanvasImageSource image, int width, int height, [dynamic angleDegree = 90]) CanvasElement
Rotates image (a CanvasImageSource) with angleDegree.
rotateImageElement(ImageElement image, [dynamic angleDegree = 90]) CanvasElement
Rotates image with angleDegree.
runZoned<R>(R body(), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification, Function? onError}) → R
Runs body in its own zone.
runZonedGuarded<R>(R body(), void onError(Object error, StackTrace stack), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification}) → R?
Runs body in its own error zone.
scalePoints(List<Point<num>> points, double scale) List<Point<num>>
Scales points to scale.
scalePointsXY(List<Point<num>> points, double scaleX, double scaleY) List<Point<num>>
Scales points to scaleX and scaleY.
scheduleMicrotask(void callback()) → void
Runs a function asynchronously.
scrollTo(num? x, num? y, {bool smooth = true, int? delayMs, Object? scrollable}) → void
Scrolls viewport to x,y.
scrollToBottom({bool smooth = true, int? delayMs}) → void
Scrolls viewport to the bottom.
scrollToElement(Element element, {bool centered = true, bool vertical = true, bool horizontal = true, bool smooth = true, int? translateX, int? translateY, Object? scrollable}) → void
Scrolls the viewport to the element.
scrollToLeft({bool smooth = true, int? delayMs}) → void
Scrolls viewport to the left border.
scrollToRight({bool smooth = true, int? delayMs}) → void
Scrolls viewport to the right border.
scrollToTop({bool smooth = true, int y = 0, bool fixSafariIOS = false, int? delayMs}) → void
Scrolls viewport to the top.
scrollToTopDelayed(int delayMs) → void
Use scrollToTop instead.
selectCssRuleWithSelector(Pattern targetSelector) List<CssRule>
Returns a list of CssRule with targetSelector patterns.
setDivCentered(DivElement div, {bool centerVertically = true, bool centerHorizontally = true, bool checkBootstrapClasses = true}) → void
Sets div as centered content, using display property as table and sub div elements display property as table-cell.
setElementBackgroundBlur(Element element, [int? blurSize]) → void
Sets element background as a blur effect of size blurSize. Uses CSS property backdrop-filter.
setElementHREF(Element element, String href) bool
Sets element href depending of the identified type.
setElementInnerHTML(Element element, String html, {NodeValidator? validator}) → void
Sets the inner HTML of element with parsed result of html.
setElementScrollColors(Element element, int scrollWidth, String scrollButtonColor, [String? scrollBgColor]) String?
Sets element scroll colors, using standard CSS property scrollbar-color and webkit pseudo element ::-webkit-scrollbar-thumb and ::-webkit-scrollbar-track
setElementSRC(Element element, String src) bool
Sets the element src depending of the identified type.
setElementValue(Element? element, String value) bool
Sets the element value depending of the identified type.
setMetaViewportScale({String? minimumScale, String? maximumScale}) bool
Sets the meta viewport with minimumScale and maximumScale.
setTreeElementsBackgroundBlur(Element element, String className) → void
setTreeElementsDivCentered(Element element, String className, {bool centerVertically = true, bool centerHorizontally = true}) → void
Set all element sub div with className to centered content.
setZoom(String zoom) → void
Sets the viewport zoom.
showDialogElement(Element content, {double? transparency, String? padding}) DivElement
Shows an Element dialog.
showDialogHTML(String? html, {double? transparency, String? padding, NodeValidator? validator}) DivElement?
Shows a html dialog.
showDialogImage(String src) → void
Shows an image (src) dialog.
showDialogText(String? text, {double? transparency, String? padding}) DivElement?
Shows a text dialog.
sortMapEntries<K, V>(Map<K, V> map, [CompareMapEntryFunction<K, V>? compare, bool reversed = false]) Map<K, V>
Returns a Map with sorted entries.
sortMapEntriesByKey<K, V>(Map<K, V?> map, [bool reversed = false]) Map<K, V?>
Returns a Map sorted by keys.
sortMapEntriesByValue<K, V>(Map<K, V> map, [bool reversed = false]) Map<K, V>
Returns a Map sorted by keys.
split(String s, Pattern delimiter, [int? limit]) List<String>
Splits s using delimiter and limit.
sumIterable<I, R>(Iterable<num> iterable, {num init = 0}) num
Uses mergeIterable to sum all iterable values.
toCamelCase(String s) String
Formats s with camel case style.
toCanvasElement(CanvasImageSource imageSource, int width, int height) CanvasElement
Converts imageSource to CanvasElement.
toDataURLBase64(String? mediaType, String base64) String
Builds a DATA URL string.
toEncodableJSON(Object? o) Object?
Ensures that o is an encodable JSON tree.
toEncodableJSONList(List? list) List
Ensures that list is an encodable JSON tree.
toEncodableJSONMap(Map? map) Map
Ensures that map is an encodable JSON tree.
toFlatListOfStrings(Object? s, {Pattern? delimiter, bool trim = true, bool ignoreEmpty = true}) List<String>
Converts s to a List<String>. Converts any collection to a flat list of strings.
toHTML(Element element) String
Converts element to HTML.
toIntlMessageResolver(Object? resolver) IntlMessageResolver?
Converts resolver to IntlMessageResolver.
toNonNullList<T>(List? list, {bool forceTypeCast = true}) List<T>
Converts list to a List<T> ignoring any null element.
toNonNullMap<K, V>(Map? map, {bool forceTypeCast = true}) Map<K, V>
Converts map to a Map<K,V> ignoring any entry with null key or null value.
toNonNullSet<T>(Set? set, {bool forceTypeCast = true}) Set<T>
Converts set to a Set<T> ignoring any null element.
touchEventToMouseEvent(TouchEvent event) MouseEvent?
Converts a TouchEvent event to a MouseEvent.
toUpperCaseInitials(String s) String
Formats s with initial character to Upper case.
transformToList<T>(Object? o) List<T>
transformToType<T>(Object? o) → T?
translatePoints(List<Point<num>> points, num x, num y) List<Point<num>>
Translate pints in x and y.
unawaited(Future<void>? future) → void
Explicitly ignores a future.
unquoteString(String s) String
Removes quotes from String s

Typedefs

AnimationCallback = void Function()
AsyncContentProvider = Future? Function()
AuthorizationInterceptor = void Function(Authorization? authorization)
AuthorizationProvider = Future<Credential?> Function(HttpClient client, HttpError? lastError)
BodyBuilderFunctionDynamic = dynamic Function(Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
BodyBuilderFunctionSimpleDynamic = dynamic Function()
BodyBuilderFunctionSimpleString = String Function()
BodyBuilderFunctionString = String Function(Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
BUIViewPropertyProvider = String Function(BUIView view)
CapturePhotoEditor = FutureOr<ImageElement?> Function(ImageElement image)
CompareMapEntryFunction<K, V> = int Function(MapEntry<K, V> entry1, MapEntry<K, V> entry2)
ContentGenerator<T> = dynamic Function(T? entry)
ControllerCallback = void Function()
Type of a stream controller's onListen, onPause and onResume callbacks.
ControllerCancelCallback = FutureOr<void> Function()
Type of stream controller onCancel callbacks.
Copier = T? Function<T>(T? o)
CreatePeriodicTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer))
The type of a custom Zone.createPeriodicTimer implementation function.
CreateTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f())
The type of a custom Zone.createTimer implementation function.
DataTransformerFrom<T> = dynamic Function(T? data)
DataTransformerFromList<T> = dynamic Function(List<T>? dataList)
DataTransformerTo<T> = T? Function(Object? o)
DataTransformerToList<T> = List<T>? Function(Object? o)
DOMElementGenerator<T> = T Function(Object? parent)
DOMElementGeneratorFunction<T> = T Function()
DOMNodeInstantiator<T extends DOMNode> = T? Function()
DOMNodeValidator<T extends DOMNode> = bool Function(T? node)
DynCallCredentialParser<E> = DynCallCredential? Function(String? output, String? outputFiltered, Map<String, String?>? parameters, Map<String, String?>? requestParameters)
DynCallFunction<R, T> = Future<R> Function(DynCall<R, T>? dynCall, Map<String, String?>? parameters)
ElementGeneratedMatchingFunction<T> = bool Function(T element)
ElementGeneratorFunction<T> = T Function(DOMGenerator<T> domGenerator, String? tag, T? parent, Map<String, DOMAttribute> attributes, T? contentHolder, List<DOMNode>? contentNodes, DOMContext<T>? context)
ElementRevertFunction<T> = DOMElement Function(DOMGenerator<T> domGenerator, DOMTreeMap<T>? treeMap, DOMElement? domParent, T? parent, T? node)
ElementValueGetter<T> = T? Function(Element element)
Returns a value from an Element.
ErrorCallbackHandler = AsyncError? Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace? stackTrace)
The type of a custom Zone.errorCallback implementation function.
EventValidatorFunction<T> = bool Function(EventStream<T> eventStream, T event)
ExecutorWrapper = DynCallExecutor Function(DynCallExecutor executor)
FieldInputRender = dynamic Function(InputConfig inputConfig)
FieldValueEvent = void Function(dynamic event)
FieldValueNormalizer<V> = V? Function(String field, V? value)
FieldValueProvider = dynamic Function(String field)
FieldValueValidator = bool Function(String field, String? value)
FilterElement = bool Function(UIElement elem)
FilterRendered = bool Function(dynamic elem)
ForEachComponent = void Function(Object elem)
ForEachElement = void Function(UIElement elem)
ForkHandler = Zone Function(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification? specification, Map<Object?, Object?>? zoneValues)
The type of a custom Zone.fork implementation function.
FunctionTest = bool Function()
HandleUncaughtErrorHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace)
The type of a custom Zone.handleUncaughtError implementation function.
HttpBodyBuilder = dynamic Function(Map<String, String?> parameters)
Function to dynamically build a HTTP body.
HttpBodyBuilderTyped = dynamic Function(Map<String, String?> parameters, String? type)
HttpClientURLFilter = String Function(String url, Map<String, String?>? queryParameters)
HTTPJSONOutputFilter = dynamic Function(dynamic json, Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
HTTPOutputFilter = String Function(String? output, Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
HTTPOutputInterceptor<E> = void Function(DynCallExecutor<E?> executor, String? outputOriginal, bool outputValid, String? outputFiltered, Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
HTTPOutputValidator = bool Function(String? output, Map<String, String?>? callParameters, Map<String, String?>? requestParameters)
ImageFilter = CanvasImageSource Function(CanvasImageSource? image, int width, int height)
Applies a filter to image, of width and height.
IntlMessageResolver = String? Function(String key, [Map<String, dynamic>? parameters])
LoaderFunction = Future<bool> Function()
MappedFunction = dynamic Function(dynamic o)
MatchesValue = bool Function(String value)
NamedElementGenerator<T> = T Function(String name, DOMGenerator<T>? domGenerator, DOMTreeMap<T> treeMap, DOMElement? domParent, Object? parent, String? tag, Map<String, DOMAttribute> attributes)
NodeSelector = bool Function(DOMNode? node)
OnCachedResponse = void Function(HttpResponse cachedResponse)
OnElementEvent = void Function(Element element)
OnElementTrackValueEvent<T> = bool Function(Element element, T? value)
OnHttpError = OnHttpErrorAnswer Function(HttpError? error)
PagingFormatInstantiator = JSONPaging Function(dynamic json)
PagingFormatMatcher = bool Function(Object? json)
PagingRequester = Future<JSONPaging?> Function(int page)
A Function that performs a paging request.
ParameterProvider = String Function(String key)
ParametersProvider = Map<String, String> Function()
ParserFunction<T, R> = R Function(T value)
PrintHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, String line)
The type of a custom Zone.print implementation function.
ProgressListener = void Function(HttpRequest request, int? loaded, int? total, double? ratio, bool upload)
QueryElementProvider = dynamic Function(String query)
RegisterBinaryCallbackHandler = ZoneBinaryCallback<R, T1, T2> Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2))
The type of a custom Zone.registerBinaryCallback implementation function.
RegisterCallbackHandler = ZoneCallback<R> Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.registerCallback implementation function.
RegisterUnaryCallbackHandler = ZoneUnaryCallback<R, T> Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg))
The type of a custom Zone.registerUnaryCallback implementation function.
RenderAsync = Future? Function(Map<String, dynamic> properties)
RenderPropertiesProvider = Map<String, dynamic> Function()
RequestHeadersBuilder = Map<String, String> Function(HttpClient client, String url)
ResponseHeaderGetter = String? Function(String headerKey)
ResponseProcessor = void Function(HttpClient client, Object request, HttpResponse response)
RunBinaryHandler = R Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2)
The type of a custom Zone.runBinary implementation function.
RunHandler = R Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.run implementation function.
RunUnaryHandler = R Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg)
The type of a custom Zone.runUnary implementation function.
ScheduleMicrotaskHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, void f())
The type of a custom Zone.scheduleMicrotask implementation function.
SimulateResponse = dynamic Function(String url, Map<String, String?>? queryParameters)
StateEventListener = void Function(StateOperation op, State state, String key, dynamic value)
StateKeyListener = void Function(dynamic value)
StringMapper<T> = T Function(String s)
SysCallCallback<O> = void Function(O output, Map<String, dynamic>? parameters)
Callback function.
SysCallOutputFilter<O, E> = O Function(E output)
SysProgressListener<O> = void Function(int? loaded, int? total, double? ratio, bool upload)
Progress function.
TypeTester<T> = bool Function(T value)
UIComponentAttributeAppender<C extends UIComponent, T> = void Function(C uiComponent, T? value)
UIComponentAttributeCleaner<C extends UIComponent, T> = void Function(C uiComponent)
UIComponentAttributeGetter<C extends UIComponent, T> = T? Function(C uiComponent)
UIComponentAttributeParser<T> = T? Function(dynamic value)
UIComponentAttributeSetter<C extends UIComponent, T> = void Function(C uiComponent, T? value)
UIComponentInstantiator<C extends UIComponent> = C Function(UIElement? parent, Map<String, DOMAttribute> attributes, UINode? contentHolder, List<DOMNode>? contentNodes)
UIEventListener = void Function(dynamic event, List? params)
URLFilter = URLLink Function(String url)
ValueCopier<T> = T? Function(T? value)
ValueFilter = bool Function(Object? collection, Object? key, Object? value)
ValueReplacer = Object? Function(Object? collection, Object? key, Object? value)
ValueValidator<V> = bool Function(V? value)
ZoneBinaryCallback<R, T1, T2> = R Function(T1, T2)
ZoneCallback<R> = R Function()
ZoneUnaryCallback<R, T> = R Function(T)

Exceptions / Errors

AsyncError
An error and a stack trace.
DeferredLoadException
Thrown when a deferred library fails to load.
ParallelWaitError<V, E>
Error thrown when waiting for multiple futures, when some have errors.
TimeoutException
Thrown when a scheduled timeout happens while waiting for an async result.