Skip to content

on

on 类用于生成绑定 DOM 事件函数代码的助手,可以方便进行前端事件绑定。

继承关系

onjsCallbackjsHelperjsdirective

构造

构造方法

定义

php
public function __construct(string $event, ?string $selector = null, array $options = array())

参数

  • $event:事件名称。
  • $selector:委托事件选择器。
  • $options:事件选项,包括 stoppreventself

示例:

php

$handleBtnClick = new on('click');

$handleBtnClick->call('window.open', 'https://openzui.com/zin/', '_blank');

辅助方法

通过与 on 类同名的辅助函数来快速创建 on 对象。

定义

php
function on(string $event, ?string $selector = null, array $options = array())

参数

  • $event:事件名称。
  • $selector:委托事件选择器。
  • $options:事件选项,包括 stoppreventself

返回值

  • on 对象。

例如:

php
on('click')-call('window.open', 'https://openzui.com/zin/', '_blank');

提示

推荐使用辅助方法 on() 来创建 on 对象,相比较 new on() 语法,辅助方法更加简洁。

属性

$event

事件名称,定义:

php
public string $event;

$selector

作为委托事件选择器,定义:

php
public ?string $selector;

$compatible

是否为兼容模式,将事件绑定代码直接添加到页面,而不是使用 [zui-init],定义:

php
public bool $compatible = false;

方法

prevent

设置阻止事件默认行为选项。

定义

php
public function prevent(bool $prevent = true): self

参数

  • $prevent:是否阻止事件默认行为。

返回值

  • self 自身,支持链式调用。

stop

设置停止事件冒泡选项。

定义

php
public function stop(bool $stop = true): self

参数

  • $stop:是否停止事件冒泡。

返回值

  • self 自身,支持链式调用。

self

设置只在自身元素上触发事件选项。

定义

php
public function self(bool $self = true): self

参数

  • $self:是否只在自身元素上触发事件。

返回值

  • self 自身,支持链式调用。

静态成员

__callStatic

魔术方法,用于定义函数。

定义

php
public static function __callStatic(string $event, array $args): on;

参数

  • $event:事件名称。
  • $args:参数数组,第一个参数为委托事件选择器,第二个参数为事件选项。

返回值

  • on 对象。

示例:

php
on::click('#btn')-call('window.open', 'https://openzui.com/zin/', '_blank');

https://zentao.net