@pluginjs/nav-to-select

NavToSelect

A flexible modern nav-to-select js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/nav-to-select

NPM

npm i @pluginjs/nav-to-select

Getting Started

CDN:

Development:

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

Production:

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

Initialize

HTML:

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

ECMAScript Module:

import NavToSelect from "@pluginjs/nav-to-select"
import "@pluginjs/nav-to-select/dist/nav-to-select.css"

NavToSelect.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/nav-to-select/dist/nav-to-select.css")
const NavToSelect = require("@pluginjs/nav-to-select")

NavToSelect.of(document.querySelector('.element'), options)

Browser:

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

API

Options

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

Name	Description	Default
"maxLevel"	Set max of plugin level	4
"prependTo"	Set prepento	null
"activeClass"	Set active class	active
"linkSelector"	Set link selector	a:first
"indentString"	Set indent string	–
"indentSpace"	Set enable indent space or not	true
"placeholder"	Set placeholder value	Navigate to...
"useOptgroup"	Set enable use opt group or not	false
"itemFilter"	Set item filter callback	function() {...}
"getItemLabel"	Set get item label callback	function() {...}
"getItemsFromList"	Set get items from list callback	function() {...}
"onChange"	Set change event callback	function() {...}

Events

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

Name	Description
"update"	Gets fired when plugin is destroy
"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 navToSelect instances through the navToSelect 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
"getItemValue"	Get item value of plugin
"isLinkable"	Get if linkable or not
"isActived"	Get is Actived
"isBuilded"	Get has builded or not
"getSelect"	Get select value

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-navToSelect "SELECT" | Declare plugin select | {namespace} "THEME" | Declare plugin theme | {namespace}--{theme}

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/nav-to-select is Licensed under the GPL-v3 license.

If you want to use @pluginjs/nav-to-select 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 [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.