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

@voscausa/svelte-use-validate

v1.4.8

Published

A Svelte use:action to validate inputs

Downloads

11

Readme

svelte-use-validate

Features

  • html inputs and svelte component validation
  • keystroke reactive and optional reactive updates
  • validation rules and rule chaining
  • lazy validation (on first use) and OK (validate all)
  • tooltip like messages and invalid field border markers
  • dynamic rulechains (update rules and optional rules)
  • add custom validators and cross field validators
  • validator controls to control validator behaviour

Installation

npm install -D @voscausa/svelte-use-validate

Config example

// rulesConfig = { node.id: rule or [rulechain ...], ...}
const rulesConfig = {
  day: ["required", { range: { min: 1, max: 31 } }, "dayOk"],
  month: ["required", { range: { min: 1, max: 12 } }],
  grossValue: ["required", "cents"],
  section: ["required", "sectionContra"], // optional contra
  contra: "get", // get default: "" if section has no contra
  note: "get",
  account_number: ["required", "ibanNum"], // alt rule with ibanRuleChains(iban)
  iban: "ibanType", // alt rule with ibanRuleChains(iban)
  title: ["required", { len: { operator: ">=", len: 10, msg: "length must be >= 10" } }],
};

Initialize validation instance

import { validate } from "@voscausa/svelte-use-validate";

// not valid markers for components
const notValidMarkers = { contra: false, section: false, grossValue: false };

const { field, OK, addValidator, fieldValues, runRuleChain } = validate(
  { rulesConfig, lazy: true, markDefault: 3 , alertBelow: 0, setNotValid},
  (id, notValid, value) => {
    // callback to update bindings or signal notValid components
    if (id in notValidMarkers) notValidMarkers[id] = notValid;
  }
);

Validate instance config options:

  • rulesConfig : rulesConfig object
  • lazy : validate on first use (default: true)
  • OK() : check all rules (check all before submit)
  • addValidator : add a custom validator
  • markDefault : mark invalid inputs:
    • 1 : input border only
    • 2 : message below the input only
    • 3 : both border and message
    • 0 : do not mark invalid inputs
  • alertBelow : position (in pics) of the alert msg below the input (default: 0)
  • setNotValid : optional custom validator helper function to mark invalid fields

Validator funtions

Validator functions have two types of arguments:

  • configured rule arguments like min, max, len, msg and so on
  • the field context (this)
    • id: field id, default: node.name (a unique id for an html element)
    • node: the html element
    • value: the field value
    • controls: array of values to (cross) control the behaviour of the validator
    • mark: field has to be marked with border and or text (default: 3)

A validator returns notValid (true or false). True breaks the rule chain.

Svelte use action field function arguments and defaults

use:field={value} or use:field={obj}
// where the value / obj argument will be decomposed as show below:
let { value, id = node.name, mark = 3, controls = [] } = obj;    

Dynamic rule chaines and cross field validation

// alt rulechain selection to validate an account_number
addValidator("ibanType", function () {
  runRuleChain.account_number(
    // here we use the iban bool as a control
    this.value
      ? ["required", "ibanNum"]
      : ["required", { len: { operator: ">=", len: 3, msg: "not IBAN; length must be > 3" } }]
  );
  // this iban validator is always OK, return false (bool always OK)
  return false;
});
// alt rulechain selection to validate an optional contra
addValidator("sectionContra", function () {
  runRuleChain.contra(
    // hasContra control => require a contra account input
    this.controls[0]
      ? ["required", { func: { fn: validContraSection, msg: "contra section missing" } }]
      : "get" // no contra account => contra account = ""
  );
  // this section validator is always OK, so return false
  return false;
});

Examples

An example Svelte SPA can be found here: voscausa/use-validate-example

use-validate example form