Classes

classes is a utility JavaScript library for control class interfaces.

Introduction

Installation

Yarn

yarn add @pluginjs/classes

NPM

npm i @pluginjs/classes

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/classes/dist/classes.js"></script>

Production:

<script src="https://unpkg.com/@pluginjs/classes/dist/classes.min.js"></script>

API

addClass

Add specified class values. If these classes already exist in attribute of the element, then they are ignored.

Parameters

| Name | Type | Description | |||-| | className | String[] | function rest parameter |

Returns

| Name | Type | Description | |||-| | element | HTMLElement | |

removeClass

Remove specified class values.

Parameters

| Name | Type | Description | |||-| | className | String[] | function rest parameter |

Returns

| Name | Type | Description | |||-| | element | HTMLElement | |

indexOfClass

Return class value by index in collection.

Parameters

| Name | Type | Description | |||-| | className | String | | | element | HTMLElement | |

Returns

| Name | Type | Description | |||-| | index | Number | index of class |

hasClass

Checks if specified class value exists in class attribute of the element.

Parameters

| Name | Type | Description | |||-| | className | String | | | element | HTMLElement | |

Returns

| Name | Type | Description | |||-| | hasClass | Boolean | |

toggleClass

Toggle class value; i.e., if class exists then remove it and return false, if not, then add it and return true.

Parameters

| Name | Type | Description | |||-| | className | String | | | element | HTMLElement | |

Returns

| Name | Type | Description | |||-| | element | HTMLElement | |

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/classes is Licensed under the GPL-v3 license.

If you want to use @pluginjs/classes project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.