zin

Appearance

jQuery ​

jQuery 类用于生成操作上下文的 jQuery 代码，可以方便的调用 jQuery 方法。

继承关系

jQuery ⇒ jsContext ⇒ js ⇒ directive

构造 ​

构造方法 ​

定义

php
 public function __construct(string $selector, ?string $name = null, string|array|js|null ...$codes)

参数

  • $selector：选择器。
  • $name：jQuery 对象名称，如果为 null 则使用默认名称。
  • $codes：JS 代码，可以是字符串或 js 对象，也可以是可被忽略的 null，或者是以上类型的数组。

示例：

php
$btn = new jQuery('#btn');

$btn->addClass('primary')->text('点击');

辅助方法 ​

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

定义

php
function jQuery(string $selector, ?string $name = null, string|array|js|null ...$codes)

参数

  • $selector：选择器。
  • $name：jQuery 对象名称，如果为 null 则使用默认名称。
  • $codes：JS 代码，可以是字符串或 js 对象，也可以是可被忽略的 null，或者是以上类型的数组。

返回值

  • jQuery 对象。

例如：

php
jQuery('#btn')->addClass('primary')->text('点击');

提示

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

方法 ​

addClass ​

为元素添加类。

定义

php
public function addClass(mixed ...$classList): self

参数

  • $classList：类列表，可以是字符串或字符串数组。

返回值

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

setClass ​

为元素设置 CSS 类。

定义

php
public function setClass(mixed ...$classList): self

参数

  • $classList：类列表，可以是字符串或字符串数组。

返回值

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

removeClass ​

从元素移除类。

定义

php
public function removeClass(mixed ...$classList): self

参数

  • $classList：类列表，可以是字符串或字符串数组。

返回值

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

toggleClass ​

切换元素的类。

定义

php
public function toggleClass(mixed $classList, string $condition): self

参数

  • $classList：类列表，可以是字符串或字符串数组。
  • $condition：判断条件，可以是字符串或 js 对象。

返回值

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

css ​

设置元素的 CSS 属性。

定义

php
/** 设置元素的 CSS 属性。 */
public function css(string $name, mixed $value): self

/** 通过对象设置元素的多个 CSS 属性。 */
public function css(array|object $style): self

参数

  • $name：CSS 属性名称。
  • $value：CSS 属性值。
  • $style：CSS 属性对象，键为属性名称，值为属性值。

返回值

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

attr ​

设置元素的 HTML 属性。

定义

php
/** 设置元素的 HTML 属性。 */
public function attr(string $name, mixed $value): self

/** 通过对象设置元素的多个 HTML 属性。 */
public function attr(array|object $attrs): self

参数

  • $name：HTML 属性名称。
  • $value：HTML 属性值。
  • $attrs：HTML 属性对象，键为属性名称，值为属性值。

返回值

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

removeAttr ​

为元素移除 HTML 属性。

定义

php
public function removeAttr(string $name): self

参数

  • $name：HTML 属性名称。

返回值

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

prop ​

设置元素的 DOM 属性。

定义

php
/** 设置元素的 DOM 属性。 */
public function prop(string $name, mixed $value): self

/** 通过对象设置元素的多个 DOM 属性。 */
public function prop(array|object $props): self

参数

  • $name：DOM 属性名称。
  • $value：DOM 属性值。
  • $props：DOM 属性对象，键为属性名称，值为属性值。

返回值

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

removeProp ​

为元素移除 DOM 属性。

定义

php
public function removeProp(string $name): self

参数

  • $name：DOM 属性名称。

返回值

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

show ​

显示元素。

定义

php
public function show(): self

返回值

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

hide ​

隐藏元素。

定义

php
public function hide(): self

返回值

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

toggle ​

切换元素的显示状态。

定义

php
public function toggle(?bool $toggle = null): self

参数

  • $toggle：是否显示，如果为 null 则根据当前状态切换。

返回值

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

trigger ​

触发元素的事件。

定义

php
public function trigger(string $event, mixed ...$args): self

参数

  • $event：事件名称。
  • $args：事件参数。

返回值

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

on ​

为元素绑定事件。

定义

php
/** 为元素绑定事件。 */
public function on(string $event, string|js $callback): self

/** 为元素绑定委托事件。 */
public function on(string $event, string $selector, string|js $callback): self

参数

  • $event：事件名称。
  • $selector：要绑定委托事件的目标元素的选择器。
  • $callback：要绑定的事件回调函数。

返回值

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

off ​

为元素解绑事件。

定义

php
public function off(string $event): self

参数

  • $event：事件名称。

返回值

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

html ​

设置元素的 HTML 内容。

定义

php
public function html(string $html): self

参数

  • $html：HTML 内容。

返回值

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

text ​

设置元素的文本内容。

定义

php
public function text(string $text): self

参数

  • $text：文本内容。

返回值

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

val ​

设置元素的值。

定义

php
public function val(mixed $val): self

参数

  • $val：值。

返回值

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

empty ​

清空元素的内容。

定义

php
public function empty(): self

返回值

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

remove ​

移除元素。

定义

php
public function remove(): self

返回值

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

each ​

遍历元素。

定义

php
public function each(string|jsCallback $callback): self

参数

  • $callback：回调函数。

返回值

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

insertAfter ​

将元素插入到指定元素后面。

定义

php
public function insertAfter(string $selector): self

参数

  • $selector：目标元素的选择器。

返回值

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

insertBefore ​

将元素插入到指定元素前面。

定义

php
public function insertBefore(string $selector): self

参数

  • $selector：目标元素的选择器。

返回值

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

after ​

在元素后面插入内容。

定义

php
public function after(string $selectorOrContent): self

参数

  • $selectorOrContent：目标元素的选择器或内容。

返回值

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

before ​

在元素前面插入内容。

定义

php
public function before(string $selectorOrContent): self

参数

  • $selectorOrContent：目标元素的选择器或内容。

返回值

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

append ​

在元素内部的最后插入内容。

定义

php
public function append(string $selectorOrContent): self

参数

  • $selectorOrContent：目标元素的选择器或内容。

返回值

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

prepend ​

在元素内部的最前插入内容。

定义

php
public function prepend(string $selectorOrContent): self

参数

  • $selectorOrContent：目标元素的选择器或内容。

返回值

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

appendTo ​

将元素插入到指定元素内部的最后。

定义

php
public function appendTo(string $selector): self

参数

  • $selector：目标元素的选择器。

返回值

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

prependTo ​

将元素插入到指定元素内部的最前。

定义

php
public function prependTo(string $selector): self

参数

  • $selector：目标元素的选择器。

返回值

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

replaceWith ​

用指定内容替换元素。

定义

php
public function replaceWith(string $selectorOrContent): self

参数

  • $selectorOrContent：目标元素的选择器或内容。

返回值

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

width ​

设置元素的宽度。

定义

php
public function width(string|int $width): self

参数

  • $width：宽度。

返回值

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

height ​

设置元素的高度。

定义

php
public function height(string|int $height): self

参数

  • $height：高度。

返回值

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

静态成员 ​

selector ​

根据选择器生成创建 jQuery 对象的代码。

定义

php
public static function selector(string $selector): string

参数

  • $selector：选择器。

返回值

示例：

php
jQuery::selector('#btn'); // $('#btn')

https://zentao.net

Copyright (C) 2023 cnezsoft.com