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

@pimred/whcaptcha

v0.2.1

Published

React client for WHCaptcha

Downloads

125

Readme

React Client for WHCaptcha

Install

npm install --save @pimred/whcaptcha

Requirements

  • configurationId: ID of the configuration from initial setup
  • sessionString: ID that is unique per user and per submission (optional)
    If no sessionString is passed it will be created automatically and stores in the Browser's session storage

Usage

Minimal example

import { WHCaptcha, useWHCaptcha } from '@pimred/whcaptcha'
import '@pimred/whcaptcha/dist/whcaptcha.css'

const Example = () => {
  const configurationId = 'configuration from initial setup'
  const { checkCaptcha, componentProps } = useWHCaptcha({ configurationId })

  ...

  const onSubmit = async () => {
    const captchaIsCorrect = await checkCaptcha()
    if (captchaIsCorrect) {
      ...
    }
  }
  ...

  return (
    <form>
      ...
      <WHCaptcha {...componentProps} />
      <button onClick={onSubmit} />
    </form>
  )
}

Example with session string

import { WHCaptcha, useWHCaptcha } from '@pimred/whcaptcha'
import '@pimred/whcaptcha/dist/whcaptcha.css'

const Example = () => {
  const configurationId = 'configuration from initial setup'
  const sessionString = 'identifier for a user session'
  const { checkCaptcha, componentProps } = useWHCaptcha({ configurationId, sessionString })

  ...

  const onSubmit = async () => {
    const captchaIsCorrect = await checkCaptcha()
    if (captchaIsCorrect) {
      ...
    }
  }
  ...

  return (
    <form>
      ...
      <WHCaptcha {...componentProps} />
      <button onClick={onSubmit} />
    </form>
  )
}

Validation on the server

API endpoint

import { WHCaptchaApi } from '@pimred/whcaptcha'

// API route GET /api/whcaptcha
const handleRequest = async (req, res) => {
  const { solution, sessionString } = req.query
  const isCorrect = WHCaptchaApi.checkCaptcha(process.env.WHCAPTCHA_CONFIGURATION_ID, sessionString, solution)
  return res.json({ isCorrect })
}

Frontend

import { WHCaptcha, useWHCaptcha } from '@pimred/whcaptcha'
import '@pimred/whcaptcha/dist/whcaptcha.css'

const Example = () => {
  const configurationId = 'configuration from initial setup'
  const { componentProps, getSessionString, getSolution } = useWHCaptcha({ configurationId })

  ...

  const onSubmit = async () => {
    const captchaValidationFromServer = await fetch(`/api/whcaptcha?sessionString=${getSessionString()}&solution=${getSolution()}`).then(response => response.json())
    if (captchaValidationFromServer.isCorrect) {
      ...
    }
  }
  ...

  return (
    <form>
      ...
      <WHCaptcha {...componentProps} />
      <button onClick={onSubmit} />
    </form>
  )
}

API

Hook: useWHCaptcha

 const {
   checkCaptcha,
   loadCaptcha,
   getSessionString,
   getSolution,
   componentProps: {
     texts,
     images,
     clickedImages,
     handleClickOnImage,
     isSolved,
     isSubmitted,
     error
   }} = useWHCaptcha({ configurationId, sessionString })

The hook returns

  • checkCaptcha: Function to perform the check of captcha
    Note: when you call checkCaptcha and the result is correct you can't call it again with the same challenge. You need to reload the captcha first (with loadCaptcha).
  • loadCaptcha: Function to perform a reload of captcha
  • getSessionString: Helper function to return the session string if generated by the hook
  • getSolution: Helper function to return the selected solution
  • componentProps: Object that should be passed to the WHCaptcha component.
<WHCaptcha {...componentProps} />

Component: WHCaptcha

WHCaptcha

Pass the props from the hook: componentProps.

  • height number in pixel that will be passed to the div on order to prevent a CLS
  • language language code
  • className CSS class for the container
  • imageClassName CSS class for every image
  • headlineClassName CSS class for the headline
  • bottomLineClassName CSS class for the bottomLine