@onereach/regex-helper

0.5.15Β β€’Β PublicΒ β€’Β Published

πŸ’” DEPRECATED!!! USE @onereach/regular-expressions instead

@onereach/regex-helper

πŸ” Vue component for creating and testing Regular Expressions.

πŸš€ Usage example

<template>
  <RegexHelper :regex.sync="regex" />
</template>

<script>
  import { RegexHelper,  getRegexBodyFlags } from '@onereach/regex-helper'

  export default {
    components: {
      RegexHelper
    },

    data () {
      return {
        regex: '/\d{2}/'
      }
    },

    watch: {
      regex (v) {
        const { body, flags } = getRegexBodyFlags(v)
        console.log('regex change', new RegExp(body, flags))
      }
    }
  }
</script>

βš™ Props

{
  /**
   * RegExp value
  */
  regex: {
    type: String,
    default: ''
  },

  /**
   * Testable text value
  */
  testInput: {
    type: String, 
    default: ''
  },

  /**
   * Error message. If not empty component will be in error state.
  */
  error: {
    type: String,
    default: ''
  },

  /**
   * Input field for RegExp
  */
  regexInputVisibility: {
    type: Boolean,
    default: true
  },

  /**
   * Extended information about RegExp parts
  */
  regexDetailsVisibility: {
    type: Boolean,
    default: false
  },

  /**
   * Docs/help information popup
  */
  docsVisibility: {
    type: Boolean,
    default: false
  },

  /**
   * Testable text input field
  */
  testInputVisibility: {
    type: Boolean,
    default: false
  },

  /**
   * Extended information about findings in testInput
  */
  matchDetailsVisibility: {
    type: Boolean,
    default: false
  },

  /**
   * Text input labels
  */
  labels: {
        type: Object,
        default: () => ({ regex: '', testInput: '' })
      }

  readonly: {
    type: Boolean,
    default: false
  },
}

πŸ”₯ Events

Event Payload Description
matchFound arrayOfMatches Emitted when got match in testInput
focus null Emitted when regex input field is focused
blur null Emitted when regex input field is unfocused

Exports

{ RegexHelper, RegexDocs, getRegexBodyFlags }

Readme

Keywords

none

Package Sidebar

Install

npm i @onereach/regex-helper

Weekly Downloads

1

Version

0.5.15

License

UNLICENSED

Unpacked Size

350 kB

Total Files

18

Last publish

Collaborators

  • onereach.admin
  • onereach.user