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

react-props-check

v1.1.3

Published

Validate React properties to keep the DOM semantic.

Downloads

14

Readme

react-props-check

CI Status MIT License

react-props-check is a lightweight utility library designed to simplify prop validation in React applications. When working with React components, it's essential to ensure that your components receive the correct props to prevent unexpected issues during runtime. This package streamlines the process of validating React component props, helping you maintain code quality and reliability.

Installation

You can install react-props-check via npm or yarn. Make sure you have Node.js and npm (or yarn) installed in your project before proceeding.

Using npm

npm install react-props-check

Using yarn

yarn add react-props-check

Once the package is installed, you can import it into your React application and start using it to validate props.

Usage

react-props-check provides a simple and effective way to validate React component props. You can use it to check if a prop is one of the accepted properties defined in your application. Here's a basic example:

import isValidProp from 'react-props-check';

const isValid = isValidProp('className'); // Check if 'className' is a valid React prop

if (isValid) {
  // Prop is valid, proceed with your logic
} else {
  // Prop is not valid, handle the error
}

API Reference

isValidProp(property: ReactAcceptedProp | DataAttribute): boolean

  • property (ReactAcceptedProp | DataAttribute): The prop or data attribute to validate.

Returns true if the property is valid, false otherwise.

DataAttribute

  • DataAttribute is a string type representing data attributes in the format data-{string}.

ReactAcceptedProp

  • ReactAcceptedProp is an exported type that represents valid React props.
import { ReactAcceptedProp } from 'react-props-check';

License

This project is licensed under the MIT License - see the LICENSE.md file for details. You are free to use and distribute this package under the terms of the MIT License.