react-url
v1.0.1
Published
URL resolver for React.js, like the Django url templatetag
Downloads
15
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 namedurls
.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 thegetURL
function andprops
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 theurls
map, the URL name and the options/parameters object.- It will return the final parsed url string.