npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@modul/smartinput

v0.0.0

Published

```javascript var smartInput = new SmartInput({ element: "#textInput", dropClass: "input-drop", filterImage: filterImageFunction, allowDropFiles: true, disabled: false }); ```

Downloads

18

Readme

smartinput

var smartInput = new SmartInput({
    element: "#textInput",
    dropClass: "input-drop",
    filterImage: filterImageFunction,
    allowDropFiles: true,
    disabled: false
});
  • options:Object - настройки компонента
  • [options.element]:Element|string - Элемент. Можно указать в виде селектора. Если не указано, будет создан новый элемент
  • [options.dropClass]:string - Класс, применяемый при попытке перетащить файл. По умолчанию - "smart-input-drop-target"
  • [options.filterImage]:Function - Функция, позволяет фильтровать изображения внутри редактируемого элемента.
    по умолчанию все картинки удаляются из поля ввода. Если filterImage(img:Element) вернет true, картинка останется.
  • [options.allowDropFiles]:boolean - разрешить перетаскивание файлов. По умолчанию - true.
  • [options.disabled]:boolean - Отключить элемент. По умолчанию - зависит от наличия атрибута contenteditable
  • [options.clearOnBlur]:boolean - Очищать выделение текста при потере фокуса. Позволяет избежать бага в IE и Edge с отображением каретки.
  • return:SmartInput

Методы

SmartInput.on(eventType, handler)

function onChangeHandler(text){
    console.log("New value:", text);
}
smartInput.on("change", onChangeHandler);

Подписка на событие.

  • eventType:string - тип события
  • handler:Function - обработчик события
  • return:SmartInput

SmartInput.off(eventType, handler)

smartInput.off("change", onChangeHandler);

Отписка от события

  • eventType:string - тип события
  • [handler]:Function - обработчик события. Если не указан, отписка произойдет от всех событий данного типа
  • return:SmartInput

SmartInput.emit(eventType, ...values)

smartInput.emit("inputFile", new File(["text"], "foo.txt"));

Принудительная отправка события

  • eventType:string - тип события
  • ...values:Function - агрументы, передаваемые обработчику события
  • return:SmartInput

SmartInput.onHotkey(hotkeyDescriptor, handler)

smartInput.onHotkey({key: 13, ctrl:false, alt:false, shift:true, meta:false}, function(event){
    console.log(this.value);
    this.value = "";
});

Подписка событие нажатия горячих клавиш

  • hotkeyDescriptor:Object - описание комбинации клавиш
  • hotkeyDescriptor.key:number - код клавиши
  • [hotkeyDescriptor.ctrl]:boolean - модификатор ctrl
  • [hotkeyDescriptor.alt]:boolean модификатор alt
  • [hotkeyDescriptor.shift]:boolean модификатор shift
  • [hotkeyDescriptor.meta]:boolean модификатор meta
    Если какой-либо модификатор не указан или указан как null, событие будет обрабатываться при любом значении модификатора
  • handler:Function - обработчик события. Принимает event:KeyboardEvent, this:SmartInput
  • return:SmartInput

SmartInput.offHotkey(hotkeyDescriptor, handler)

smartInput.onHotkey({key: 13, ctrl:false, alt:false, shift:true, meta:false}, hotkeyHandler);

Отписка от события нажатия клавиш

  • hotkeyDescriptor:Object - описание комбинации клавиш
  • hotkeyDescriptor.key:number - код клавиши
  • [hotkeyDescriptor.ctrl]:boolean - модификатор ctrl
  • [hotkeyDescriptor.alt]:boolean модификатор alt
  • [hotkeyDescriptor.shift]:boolean модификатор shift
  • [hotkeyDescriptor.meta]:boolean модификатор meta
  • [handler]:Function - обработчик события, ранее добавленный. Если не указан, отписка произойдет от всех событий по данной комбинации клавиш
  • return:SmartInput

SmartInput.insert(text, options)

smartInput.insert("JS iS AwESoME",{
    deleteContents: true,
    selectEnd: true
});

Добавить текст в компонент.
Текст будет добавлен в последнюю позицию, выделенную курсором.
Если такой нет - в конец.

  • text:string - текст
  • [options]:Object
  • [options.deleteContents]:boolean - заменить выделенный текст
  • [options.selectStart]:boolean - выделить начало вставленного текста
  • [options.selectEnd]:boolean - выделить конец вставленного текста
  • [options.scrollIntoViewIfNeeded]:boolean - автоматическая прокрутка
  • return:SmartInput

SmartInput.focus(options)

smartInput.focus({
    selectStart: true,
    selectEnd: true
});

Установить фокус в элемент.
Если вызвано без параметров - будет выделен последний выделенный текст Если такого текста нет или выделенный контент быз изменен - курсор встанет в конец

  • [options]:Object
  • [options.selectStart]:boolean - установить курсор в начало
  • [options.selectEnd]:boolean - установить курсор в конец. Вместе с selectStart - выделить весь текст

SmartInput.destroy()

smartInput.destroy();

Используется, чтобы отключить все внутренние обработчики событий для этого компонента

Свойства

value

console.log( "Input value: ", smartInput.value );
smartInput.value += "text";

Текст, который отображается внутри элемента. Тип: string
При инициализации вычисляется по содержимому элемента.

disabled

console.log( "Input disabled: ", smartInput.disabled );
smartInput.disabled = !smartInput.disabled;

Доступен ли текст для редактирования. Тип: boolean
При инициализации вычисляется по наличию атрибута contenteditable="true".

placeholder

console.log( "Input placeholder: ", smartInput.placeholder );
smartInput.placeholder = !smartInput.placeholder;

Задаёт элементу placeholder. Тип: string
При инициализации вычисляется по значению атрибута placeholder.

element

console.log( "Input element: ", smartInput.element );

Задаёт элементу placeholder. Тип: Element
Доступен только для чтения.

clearOnBlur

Очищать ли выделение текста при потере фокуса. Тип: boolean

События

change

smartInput.on("change", function(text){
    // ...
});

Событие вызывается при изменении текста внутри компонента

  • text:String - новое значение
  • this:SmartInput

inputFile

smartInput.on("inputFile", function(file){
    // ...
});

Событие вызывается при передаче файла в компонент путём перетаскивания или вставки из буфера обмена

  • file:File|Blob - передаваемый файл
  • this:SmartInput

error

smartInput.on("error", function(error){
    // ...
});

Вызывается при ошибке в любом из других обработчиков событий.

  • error:Error - ошибка
  • ...args:* - сопутствующие параметры при ошибке.
    Обычно это название события обработчика и список его аргументов.

Примечания

Safari - не работает вставка изображения из буфера обмена

IE10 и старше - не работает вставка изображения из буфера обмена

IE - обновление value и вызов события "change" происходит с небольшой задержкой, по событию keyup.

IE, Edge - необходимо скрывать placeholder средствами css, если он установлен в :before, в следующих случаях:
-- наличие фокуса
-- перетаскивание объекта в элемент