wechat/wxml

wxml module provides WXML node query bindings details in wechat document

Types

IntersectionObserver

IntersectionObserver type

pub type IntersectionObserver

MediaQueryObserver

</>

Phase 19: WXML Advanced - MediaQueryObserver

MediaQueryObserver type for responsive design

pub type MediaQueryObserver

NodesRef

</>

NodesRef type for node reference returned by select methods

pub type NodesRef

ScrollViewContext

</>

ScrollViewContext type for scroll-view component context

pub type ScrollViewContext

SelectorQuery

</>

SelectorQuery type for querying node information

pub type SelectorQuery

Values

create_intersection_observer

</>

pub fn create_intersection_observer(
  component c: object.JsObject,
  options o: object.JsObject,
) -> IntersectionObserver

wx.createIntersectionObserver Create intersection observer

create_media_query_observer

</>

pub fn create_media_query_observer(
  component c: object.JsObject,
) -> MediaQueryObserver

wx.createMediaQueryObserver Create a media query observer for responsive design

create_selector_query

</>

pub fn create_selector_query() -> SelectorQuery

wx.createSelectorQuery() Returns a SelectorQuery object instance

intersection_observer_disconnect

</>

pub fn intersection_observer_disconnect(
  io: IntersectionObserver,
) -> Nil

IntersectionObserver.disconnect Stop listening

intersection_observer_observe

</>

pub fn intersection_observer_observe(
  io: IntersectionObserver,
  target t: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

IntersectionObserver.observe Listen for intersection state change

intersection_observer_relative_to

</>

pub fn intersection_observer_relative_to(
  io: IntersectionObserver,
  selector s: object.JsObject,
) -> IntersectionObserver

IntersectionObserver.relativeTo Specify reference node

intersection_observer_relative_to_viewport

</>

pub fn intersection_observer_relative_to_viewport(
  io: IntersectionObserver,
) -> IntersectionObserver

IntersectionObserver.relativeToViewport Use viewport as reference

media_query_observer_disconnect

</>

pub fn media_query_observer_disconnect(
  mq: MediaQueryObserver,
) -> Nil

MediaQueryObserver.disconnect Stop listening for media query changes

media_query_observer_observe

</>

pub fn media_query_observer_observe(
  mq: MediaQueryObserver,
  descriptor d: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

MediaQueryObserver.observe Start observing media query changes

nodes_ref_bounding_client_rect

</>

pub fn nodes_ref_bounding_client_rect(
  ref r: NodesRef,
  callback cb: fn(object.JsObject) -> Nil,
) -> SelectorQuery

NodesRef.boundingClientRect() Add request to get node layout position relative to display area Returns NodesRef for chaining

nodes_ref_context

</>

pub fn nodes_ref_context(ref r: NodesRef) -> NodesRef

NodesRef.context() Add request to get the corresponding context object Currently supports CanvasContext, Canvas 2D, MapContext, VideoContext, AdContext, EditorContext, CameraContext, LivePlayerContext, LivePusherContext, OpenDataContext Returns NodesRef for chaining

nodes_ref_fields

</>

pub fn nodes_ref_fields(
  ref r: NodesRef,
  fields f: object.JsObject,
) -> NodesRef

NodesRef.fields(rect, dataset, computedStyle, size, scrollOffset, properties) Add request to get specified node fields Returns NodesRef for chaining

nodes_ref_node

</>

pub fn nodes_ref_node(ref r: NodesRef) -> NodesRef

NodesRef.node() Add request to get Node instance Returns NodesRef for chaining

nodes_ref_ref

</>

pub fn nodes_ref_ref(ref r: NodesRef) -> NodesRef

NodesRef.ref(component) Add request to get component instance matching the selector Returns NodesRef for chaining

nodes_ref_scroll_offset

</>

pub fn nodes_ref_scroll_offset(ref r: NodesRef) -> NodesRef

NodesRef.scrollOffset() Add request to get node scroll position Returns NodesRef for chaining

scroll_view_context_close_refresh

</>

pub fn scroll_view_context_close_refresh(
  ctx: ScrollViewContext,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.closeRefresh Close pull-down refresh

scroll_view_context_close_two_level

</>

pub fn scroll_view_context_close_two_level(
  ctx: ScrollViewContext,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.closeTwoLevel Close two-level page

scroll_view_context_scroll_into_view

</>

pub fn scroll_view_context_scroll_into_view(
  ctx: ScrollViewContext,
  selector s: String,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.scrollIntoView Scroll element into view

scroll_view_context_scroll_to

</>

pub fn scroll_view_context_scroll_to(
  ctx: ScrollViewContext,
  left l: Int,
  top t: Int,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.scrollTo Scroll to specified position

scroll_view_context_trigger_refresh

</>

pub fn scroll_view_context_trigger_refresh(
  ctx: ScrollViewContext,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.triggerRefresh Trigger pull-down refresh

scroll_view_context_trigger_two_level

</>

pub fn scroll_view_context_trigger_two_level(
  ctx: ScrollViewContext,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

ScrollViewContext.triggerTwoLevel Trigger two-level page

selector_query_exec

</>

pub fn selector_query_exec(
  query q: SelectorQuery,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

SelectorQuery.exec() Execute all requests Request results form an array in the order they were requested Returns in the first parameter of the callback

selector_query_in

</>

pub fn selector_query_in(
  query q: SelectorQuery,
  component c: object.JsObject,
) -> SelectorQuery

SelectorQuery.in(component) Change the selection scope to custom component component

selector_query_select

</>

pub fn selector_query_select(
  query q: SelectorQuery,
  selector s: String,
) -> NodesRef

SelectorQuery.select(selector) Select the first node matching selector in the current page Returns a NodesRef object instance

selector_query_select_all

</>

pub fn selector_query_select_all(
  query q: SelectorQuery,
  selector s: String,
) -> NodesRef

SelectorQuery.selectAll(selector) Select all nodes matching selector in the current page Returns a NodesRef object instance

selector_query_select_viewport

</>

pub fn selector_query_select_viewport(
  query q: SelectorQuery,
) -> NodesRef

SelectorQuery.selectViewport() Select the display area (viewport) Can be used to get display area dimensions, scroll position, etc. Returns a NodesRef object instance