Url-prop-type NPM

URL Prop Type

npm bundle size GitHub

Introduction

This package is used to validate if a React Prop value is a valid URL. A valid URL can be a valid absolute URL (like https://github.com/jaebradley/url-prop-type) or a relative-absolute URL (starts with a /).

Currently, there is no URL prop type defined by the prop-types package. While using PropType.string works, why not be as specific as possible when validating your props?

Additionally, though it's relatively straightforward to create a custom prop type validator, if you need to implement similar prop type checking in multiple packages, you might not want to repeat yourself.

Depends on the is-url package.

Installation

npm install --save url-prop-type

Example Usage

import React from 'react';
import PropTypes from 'prop-types';
import urlPropType from 'url-prop-type';

// Create a basic Hyperlink Component
const Hyperlink = props => ( <a href={props.link}>{props.text}</a> );

Hyperlink.propTypes = {
  text: PropTypes.string.isRequired,
  link: urlPropType.isRequired, // can also specify urlPropType if it is not required
};