Nihil Prius Modulus

    @pluginjs/filters

    0.8.16 • Public • Published

    Filters

    npm package

    A flexible modern filters js plugin.

    Samples

    Introduction

    Installation

    Yarn

    yarn add @pluginjs/filters

    NPM

    npm i @pluginjs/filters

    Getting Started

    CDN:

    Development:

    <script src="https://unpkg.com/@pluginjs/filters/dist/filters.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/@pluginjs/filters/dist/filters.css">

    Production:

    <script src="https://unpkg.com/@pluginjs/filters/dist/filters.min.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/@pluginjs/filters/dist/filters.min.css">

    Initialize

    HTML:

    <div class="element"></div>

    ECMAScript Module:

    import Filters from "@pluginjs/filters"
    import "@pluginjs/filters/dist/filters.css"
    
    Filters.of(document.querySelector('.element'), options)

    CommonJS:

    require("@pluginjs/filters/dist/filters.css")
    const Filters = require("@pluginjs/filters")
    
    Filters.of(document.querySelector('.element'), options)

    Browser:

    <link rel="stylesheet" href="https://unpkg.com/@pluginjs/filters/dist/filters.css">
    <script src="https://unpkg.com/@pluginjs/filters/dist/filters.js"></script>
    <script>
      Pj.filters('.element', options)
    </script>

    API

    Options

    Options are called on filters instances through the filters options itself. You can also save the instances to variable for further use.

    Name Description Default
    "theme" Add plugin theme option null
    "items" Set items with plugin null
    "default" Set default with filters null
    "valueFrom" Set value from data-id
    "template" Set plugin default template {}

    Events

    Events are called on filters instances through the filters events itself. You can also save the instances to variable for further use.

    Name Description
    "change" Gets fired when plugin is changed
    "ready" Gets fired when plugin is ready
    "enable" Gets fired when plugin is enabled
    "disable" Gets fired when plugin is disabled
    "destroy" Gets fired when plugin is destroy

    Methods

    Methods are called on filters instances through the filters method itself. You can also save the instances to variable for further use.

    Name Description
    "enable" Enabled plugin if plugin is disabled
    "disable" Disable plugin
    "destroy" Destroy plugin
    "build" Build plugin template
    "append" Append data to plugin
    "get" Get value by key
    "set" Set value by key

    Classes

    Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-filter "CONTAINER" | Declare plugin range | {namespace}s "THEME" | Declare plugin theme | {namespace}s--{theme} "ITEM" | Declare plugin item | {namespace} "ACTIVE" | Announce plugin is actived | {namespace}-active "DISABLED" | Announce plugin is disabled | {namespace}-disabled

    Browser support

    Tested on all major browsers.

    IE / EdgeIE / Edge FirefoxFirefox ChromeChrome SafariSafari OperaOpera
    IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

    License

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

    If you want to use @pluginjs/filters 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 purchase@thecreation.co.

    Copyright

    Copyright (C) 2022 Creation Studio Limited.

    Keywords

    none

    Install

    npm i @pluginjs/filters

    Homepage

    pluginjs.com

    DownloadsWeekly Downloads

    0

    Version

    0.8.16

    License

    GPL-3.0

    Unpacked Size

    87.8 kB

    Total Files

    14

    Last publish

    Collaborators

    • thecreation
    • kaptinlin