Форум

Методология

Инструментарий

Платформа

Сообщество

desktop
touch-pad
touch-phone

dom

Блок предоставляет объект, содержащий набор методов для работы с DOM-деревом.

Обзор

Свойства и методы объекта

Имя Тип возвращаемого значения Описание
contains(
ctx {jQuery},
domElem {jQuery})
Boolean Проверяет, содержит ли один DOM-элемент другой.
getFocused(
domElem {jQuery})
jQuery Служит для получения ссылки на DOM-элемент в фокусе.
containsFocus(
domElem {jQuery})
Boolean Проверят, содержит ли DOM-элемент или его потомки фокус.
isFocusable(
domElem {jQuery})
Boolean Проверят, может ли DOM-элемент находиться в фокусе.
isEditable(
domElem {jQuery})
Boolean Проверят, возможен ли в DOM-элементе ввод текста.

Публичные технологии блока

Блок реализован в технологиях:

  • js

Описание

Свойства и методы объекта

Метод contains

Метод позволяет проверить содержит ли некоторый DOM-элемент ctx элемент domElem.

Принимаемые аргументы:

  • ctx {jQuery} – DOM-элемент внутри которого производится поиск. Обязательный аргумент.
  • domElem {jQuery} – искомый DOM-элемент. Обязательный аргумент.

Возвращаемое значение: Boolean. Если искомый элемент найден – true.

Пример:

modules.require(['dom', 'jquery'], function(dom, $) {

/*
<div class="block1">
  <div class="block2"></div>
</div>
*/

dom.contains($('.block1'), $('.block2'));  // true

});

Метод getFocused

Метод служит для получения ссылки на DOM-элемент, находящийся в фокусе.

Не принимает аргументов.

Возвращаемое значение: jQuery – объект в фокусе.

Пример:

modules.require(['dom'], function(dom) {

dom.getFocused(); // ссылка на элемент в фокусе

});

Метод containsFocus

Метод проверяет находится ли в фокусе переданный аргументом DOM-элемент или один из его потомков.

Принимаемые аргументы:

  • domElem {jQuery} – проверяемый DOM-элемент. Обязательный аргумент.

Возвращаемое значение: Boolean. Если искомый элемент в фокусе – true.

Пример:

modules.require(['dom', 'jquery'], function(dom, $) {

/*
<div class="block1">
  <input class="block1__control"></div>
</div>
*/

$('.block1__control').focus();
dom.containsFocus($('.block1'));  // true

});

Метод isFocusable

Метод проверят может ли браузер пользователя установить фокус на переданный аргументом DOM-элемент.

Принимаемые аргументы:

  • domElem {jQuery} – проверяемый DOM-элемент. Обязательный аргумент. Если в jQuery-цепочке несколько DOM-элементов, то проверяется первый из них.

Возвращаемое значение: Boolean. Если фокус может быть установлен – true.

Пример:

modules.require(['dom', 'jquery'], function(dom, $) {

/*
<div class="menu">
  <a class="menu__item" href="/">Link 1</a>
</div>
*/

dom.isFocusable($('.menu__item')); // true

/*
<div class="menu">
  <span class="menu__item menu__item_current">Link 1</span>
</div>
*/

dom.isFocusable($('.menu__item')); // false

});

Метод isEditable

Метод проверят возможен ли в переданном аргументом DOM-элементе ввод текста. Другими словами, с помощью метода можно проверить является ли элемент полем ввода, текстовой областью и т.п.

Принимаемые аргументы:

  • domElem {jQuery} – проверяемый DOM-элемент. Обязательный аргумент. Если в jQuery-цепочке несколько DOM-элементов, то проверяется первый из них.

Возвращаемое значение: Boolean. Если ввод текста в элементе возможен – true.

Пример:

modules.require(['dom', 'jquery'], function(dom, $) {

dom.isEditable($('input, textarea')); // true

});

Module dom

some DOM utils

Object methods:

contains(ctx, domElem):Boolean
description
Checks whether a DOM elem is in a context
parameters
ctx
jQuery
DOM elem where check is being performed
domElem
jQuery
DOM elem to check
getFocused():jQuery
description
Returns current focused DOM elem in document
containsFocus(domElem):Boolean
description
Checks whether a DOM element contains focus
parameters
domElem
jQuery
isFocusable(domElem):Boolean
description
Checks whether a browser currently can set focus on DOM elem
parameters
domElem
jQuery
isEditable(domElem):Boolean
description
Checks whether a domElem is intended to edit text
parameters
domElem
jQuery