bianco.attr

Helper to set/get/remove DOM attributes on a list of nodes

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
bianco.attr
1.1.19 months ago6 years agoMinified + gzip package size for bianco.attr in KB

Readme

bianco.attr
!Build Statusci-imageci-url !NPM versionnpm-version-imagenpm-url !NPM downloadsnpm-downloads-imagenpm-url !MIT Licenselicense-imagelicense-url

Usage

import { set, get, has, remove } from 'bianco.attr'

// set an attribute on a node
const img = document.createElement('img')

set(img, 'width', 100)
get(img, 'width') // => '100'
has(img, 'width') // => true

remove(img, 'width')
get(img, 'width') // => null

API

Table of Contents

-   [Parameters](#parameters)
-   [Examples](#examples)
-   [Parameters](#parameters-1)
-   [Examples](#examples-1)
-   [Parameters](#parameters-2)
-   [Examples](#examples-2)
-   [Parameters](#parameters-3)
-   [Examples](#examples-3)

set

Set any attribute on a single or a list of DOM nodes

Parameters

or a list of properties as object key - value
  • value string the new value of the attribute (optional)

Examples

import { set } from 'bianco.attr'

const img = document.createElement('img')

set(img, 'width', 100)

// or also
set(img, {
  width: 300,
  height: 300
})

Returns (HTMLElement \| NodeList \| Array) the original array of elements passed to this function

get

Get any attribute from a single or a list of DOM nodes

Parameters

(string \| Array) name or list of attributes to get

Examples

import { get } from 'bianco.attr'

const img = document.createElement('img')

get(img, 'width') // => '200'

// or also
get(img, ['width', 'height']) // => ['200', '300']

// or also
get([img1, img2], ['width', 'height']) // => [['200', '300'], ['500', '200']]

Returns (Array \| string) list of the attributes found

remove

Remove any attribute from a single or a list of DOM nodes

Parameters

(string \| Array) name or list of attributes to remove

Examples

import { remove } from 'bianco.attr'

remove(img, 'width') // remove the width attribute

// or also
remove(img, ['width', 'height']) // remove the width and the height attribute

// or also
remove([img1, img2], ['width', 'height']) // remove the width and the height attribute from both images

Returns (HTMLElement \| NodeList \| Array) the original array of elements passed to this function

has

Set any attribute on a single or a list of DOM nodes

Parameters

(string \| Array) name or list of attributes to detect

Examples

import { has } from 'bianco.attr'

has(img, 'width') // false

// or also
has(img, ['width', 'height']) // => [false, false]

// or also
has([img1, img2], ['width', 'height']) // => [[false, false], [false, false]]

Returns (boolean \| Array) true or false or an array of boolean values