Naive Props Mutation

    @pluginjs/auto-complete

    0.8.16 • Public • Published

    AutoComplete

    npm package

    A flexible modern auto-complete js plugin.

    Samples

    Introduction

    Installation

    Yarn

    yarn add @pluginjs/auto-complete

    NPM

    npm i @pluginjs/auto-complete

    Getting Started

    CDN:

    Development:

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

    Production:

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

    Initialize

    HTML:

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

    ECMAScript Module:

    import AutoComplete from "@pluginjs/auto-complete"
    import "@pluginjs/auto-complete/dist/auto-complete.css"
    
    AutoComplete.of(document.queryAutoCompleteor('.element'), options)

    CommonJS:

    require("@pluginjs/auto-complete/dist/auto-complete.css")
    const AutoComplete = require("@pluginjs/auto-complete")
    
    AutoComplete.of(document.queryAutoCompleteor('.element'), options)

    Browser:

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

    API

    Options

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

    Name Description Default
    "theme" Set plugin theme option null
    "trigger" Set trigger click
    "offset" Set offset [0,0]
    "icon" Set default icon pj-icon pj-icon-char pj-icon-chevron-down
    "multiple" Set multiple false
    "clearable" Set clearable false
    "filterable" Set filterable false
    "closeAllButten" Set closeAllButton true
    "placeholder" Set input box prompt information Please auto-complete
    "notFoundText" Set notoFoundText Badge not found
    "auto-completeed" Set auto-completeed null
    "data" Set data null
    "keyboard" Set keyboard true
    "disabled" Disabled plugin false
    "templates" Set default templates {}
    "parse" The type of JSON change the type of object function() {...}
    "process" The type of object change the type of JSON function() {...}

    Events

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

    Name Description
    "update" Gets fired when plugin has destroy
    "ready" Gets fired when plugin has ready
    "enable" Gets fired when plugin has enabled
    "disabled" Disable plugin
    "destroy" Gets fired when plugin has destroy
    "load" Gets fired when plugin has load
    "open" Gets fired when plugin has open
    "close" Gets fired when plugin has close
    "click" Gets fired when plugin has click
    "change" Gets fired when plugin has changed
    "auto-complete" Gets fired when plugin has auto-complete
    "unauto-complete" Gets fired when plugin has unauto-complete
    "hide" Gets fired when plugin has hide

    Methods

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

    Name Description
    "get" Get value by key
    "set" Set value by key
    "val" Set or get value by key
    "enable" Enabled plugin if plugin is disabled
    "disable" Disable plugin
    "destroy" Destroy plugin
    "removeData" Set removeData
    "open" Get value of open
    "close" Get value of close

    Classes

    Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-auto-complete "WRAP" | Declare plugin wrap | {namespace}-wrap "MULTIPLE" | Declare plugin multiple | {namespace}-multiple "FILTERABLE" | Declare plugin filterable | {namespace}-filterable "DROPDOWNLIST" | Declare plugin dropdownlist | {namespace}-dropdown "TRIGGER" | Declare plugin trigger | {namespace}-trigger "HASBADGE" | Declare plugin hasbadge | {namespace}-hpj-badge "BADGE" | Declare plugin badge | {namespace}-badge "BADGECONTENT" | Declare plugin badge content | {namespace}-badge-content "BADGEDELETE" | Declare plugin badge delete | {namespace}-badge-delete "LABEL" | Declare plugin label | {namespace}-label "LIST" | Declare plugin list | {namespace}-list "SUBLIST" | Declare plugin sublist | {namespace}-sublist "ITEM" | Declare plugin item | {namespace}-item "GROUP" | Declare plugin group | {namespace}-group "GROUPLABEL" | Declare plugin label | {namespace}-group-label "OPEN" | Declare plugin open | {namespace}-open "NOTFOUND" | Declare plugin not found | {namespace}-not-found "DISABLED" | Announce plugin is disabled | {namespace}-disabled "MARK" | Declare plugin mark | {namespace}-mark "SELECTED" | Declare plugin auto-completeed | {namespace}-auto-completeed "FOCUS" | Declare plugin focus | {namespace}-focus "LOADING" | Declare plugin loading | {namespace}-loading "ERROR" | Declare plugin error | {namespace}-error "HIDEICON" | Declare plugin hideicon | {namespace}-hideIcon

    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/auto-complete is Licensed under the GPL-v3 license.

    If you want to use @pluginjs/auto-complete 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/auto-complete

    Homepage

    pluginjs.com

    DownloadsWeekly Downloads

    0

    Version

    0.8.16

    License

    GPL-3.0

    Unpacked Size

    135 kB

    Total Files

    16

    Last publish

    Collaborators

    • thecreation
    • kaptinlin