API
Inode

negl 機能一覧 / Exports / INode

Class: INode

DOM アクセスのアダプタです。ライブラリ内で使用しているものになりますが、皆さんのプロジェクトでは DOM に直接アクセス(document.querySelector など)していただいて大丈夫です!応用編で紹介しましたので、一応使えるようにライブラリでも提供しています。

アダプタとは?
ブラウザのバージョンアップなどで DOM へのアクセス方法などが変わったときに備えて、ブラウザのネイティブの機能などを特定の関数を通して操作するデザインパターンです。

Table of contents

Methods

Methods

addListener

Static addListener(elementOrSelector, type, fn, options?): void

addEventListener (opens in a new tab)のアダプタ

Parameters

NameTypeDescription
elementOrSelectorstring | Elementセレクタ文字列、または DOM
typestringイベントタイプ
fnEventListenerOrEventListenerObjectコールバック関数
options?boolean | AddEventListenerOptionsイベントリスナのオプション

Returns

void


getDS

Static getDS(elementOrSelector, key): undefined | string

対象の DOM のキーに対応する dataset の値を取得します。

Parameters

NameTypeDescription
elementOrSelectorstring | Elementセレクタ文字列、または DOM
keystringdataset のキー

Returns

undefined | string


getElement

Static getElement(elementOrSelector, scope?): null | Element

セレクタ文字列、または DOM を受け取り、DOM を返却します。

Parameters

NameTypeDescription
elementOrSelectorstring | Element-
scope?Element | DocumentquerySelector の検索範囲

Returns

null | Element


getRect

Static getRect(elementOrSelector): null | DOMRect

セレクタ文字列、または DOM に対応するDOMRect (opens in a new tab)を返却します。

Parameters

NameTypeDescription
elementOrSelectorstring | Elementセレクタ文字列、または DOM

Returns

null | DOMRect


hasDS

Static hasDS(elementOrSelector, key): boolean

対象の DOM の dataset にキーが存在する場合、true を返します。それ以外の場合、false。

Parameters

NameTypeDescription
elementOrSelectorstring | Elementセレクタ文字列、または DOM
keystringdataset のキー

Returns

boolean


htmlToEl

Static htmlToEl(htmlStr): Element

引数で渡された HTML 文字列を DOM にして返却します。

Parameters

NameType
htmlStrstring

Returns

Element

HTML 文字列から変換された DOM


isElement

Static isElement(target): target is Element

Element (opens in a new tab)の場合 true が返ります。それ以外、false。

Parameters

NameType
targetunknown

Returns

target is Element


qs

Static qs(selector, scope?): null | Element

querySelector (opens in a new tab)のアダプタ

Parameters

NameTypeDescription
selectorstringセレクタ文字列
scope?Element | DocumentquerySelector の検索範囲

Returns

null | Element


qsAll

Static qsAll(selector, scope?): Element[]

querySelectorAll (opens in a new tab)のアダプタ

Parameters

NameTypeDescription
selectorstringセレクタ文字列
scope?Element | DocumentquerySelectorAll の検索範囲

Returns

Element[]


removeListener

Static removeListener(elementOrSelector, type, fn, options?): void

removeEventListener (opens in a new tab)のアダプタ

Parameters

NameTypeDescription
elementOrSelectorstring | Elementセレクタ文字列、または DOM
typestringイベントタイプ
fnEventListenerOrEventListenerObjectイベント削除するコールバック関数
options?boolean | EventListenerOptionsイベントリスナのオプション

Returns

void