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

vue-highlightable-input

v1.0.9

Published

A Vue.js component that highlights text as you type

Downloads

1,273

Readme

icon npm version

Vue Highlightable Input

Highlight and style specific words as you're typing.

alt demo Try it yourself

Install

npm install vue-highlightable-input --save

Usage

In your template add this:

<highlightable-input 
  highlight-style="background-color:yellow" 
  :highlight-enabled="highlightEnabled" 
  :highlight="highlight" 
  v-model="msg"
/>

In your component add this:

import HighlightableInput from "vue-highlightable-input"
export default {
  name: 'HelloWorld',
  components : {
    HighlightableInput
  },
  data() {
    return {
      msg: '',
      highlight: [
        {text:'chicken', style:"background-color:#f37373"},
        {text:'noodle', style:"background-color:#fca88f"},
        {text:'soup', style:"background-color:#bbe4cb"},
        {text:'so', style:"background-color:#fff05e"},
        "whatever",
        {start: 2, end: 5, style:"background-color:#f330ff"}
      ],
      highlightEnabled: true
    }
  },
}

Props

| Name | Required | Type | Default | Description | Reactive | --- | --- | --- | --- | --- | --- | highlight | Yes | String or Array | null | The string or list of words to highlight. This can be a single string value, a RegExp or you can do an array of strings or RegExp or array of Highlight Objects or array of Range Objects. | Yes | | highlightEnabled | No | Boolean | true | If true, will highlight the text | Yes | | highlightStyle | No | String or Object | background-color:yellow | If no style is provided for text, this will act as the global styling for the highlight. Can also be a dictionary instead of string. | Yes | highlightDelay | No | Number | 500 | Determines how long in milliseconds to wait before processing the highlights. Setting this to a low value is fine for small text but setting it higher may improve performance significantly for larger text | Yes | caseSensitive | No | Boolean | false | If true, will treat highlight strings with case sensitivity. Can be overrided per highlight object. | Yes | value | No | String | null | Raw text value. | Yes | fireOn | No | String | keydown | The dom event on which the highlight event should be fired. This can be any event that the div content editable can handle. | No (only because the listener is being added in mounted) | fireOnEnabled | No | Boolean | true | If true, will process the highlights on the specified (or default) event. | No (only because the value is used in the mounted function)

Highlight Object

{
    text:'chicken', // Required
    style:"background-color:#f37373" // Optional
    caseSensitive: true // Optional defaults to False
}

Range Object

{
    start:1, // Required
    end: 9,  // Required
    style:"background-color:#f37373" // Optional
}

End must be greater than start. The range end is exlusive in other words ==> [start, end)

Events

| Name | Description | --- | --- | | @input | Just like a regular input html element you can use this to react to input events

Note, that you can also use v-model

Some notes

  • This is not meant to be used for large scale text highlight because of how inefficient div contentEditable is and also the fact the algorithm I'm using is stupidly inefficient (try entering like a lot of text for highlighting)
  • Good use cases for this are something like what wit.ai does (they probably have a more efficient algorithm though) for highlighting recognized entities on the fly.
  • Let me know what other use cases you might have!

Why make this?

  • I liked the way wit.ai does highlighting and I wanted to recreate that in Vue.
  • Because I was bored and also had a similar problem at work (No, I wasn't bored at work! Quite the opposite actually.)
  • Because I still know nothing about web development and I'm still a n00b. Roast me bro.
  • Because it looks cool!

Credits

For the cool highlighter pen icon: Icons made by Freepik from Flaticon is licensed by Creative Commons BY 3.0

License

MIT