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-url

v1.0.1

Published

URL resolver for React.js, like the Django url templatetag

Downloads

29

Readme

react-url

A React.js High-Order Component and decorator for parsing and resolving URLs inside your application.

Installation

npm i -S react react-url

API

URLProvider

import { render } from 'react-dom';
import { URLProvider } from 'react-url';

import App from './containers/App';

const urls = {
  profile: '/profile/:username/',
};

render(
  <URLProvider urls={urls}>
    <App />
  </URLProvider>,
  document.body,
);
  • URLProvider is a High-Order Component.
  • URLProvider expect only one property named urls.
  • urls should be an object where the keys are the URLs names and the values are the unparsed url using the syntax of Express.js.

connectURL

import React, { Component } from 'react';
import { connectURL } from 'react-url';

function mapURLToProps(getURL, props) {
  return {
    profileURL: getURL('profile', { username: props.username }),
  };
}

@connectURL(mapURLToProps)
class UserData extends Component { ... }

export default UserData;
  • The connectURL argument (mapURLToProps) it's optional.
  • If you don't supply it then it will add the getURL function as a property.
  • The mapURLToProps function will receive the getURL function and props object as parameter and should return an object.
  • The getURL function receive the URL name and an object with the parameters to use in it and return the parsed URL.
  • You can use it as a decorator (like the example above) or just as a function and send them the component to connect.

parser

import { parser } from 'react-url';

const urls = {
  profile: '/profile/:username/',
};

const profileURL = parser(urls, 'profile', {
  username: 'sergiodxa',
});
  • This is a Low-Level API and is used internally for the connectURL decorator, it's not expected that you use it directly.
  • parser receive as arguments the urls map, the URL name and the options/parameters object.
  • It will return the final parsed url string.