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

@evo/urlmapper-router

v1.0.1

Published

Router that uses urlmapper

Downloads

186

Readme

urlmapper-router

npm - https://www.npmjs.com/package/@evo/urlmapper-router

React компонент для декларативного использвания urlmapper.

Установка

npm i @evo/urlmapper-router @evo/urlmapper

Пример:

import { BrowserRouter, Route } from 'react-router-dom';
import { UrlMapperRouter} from '@evo/urlmapper-router'
import { UrlMapper, Mapper } from '@evo/urlmapper';

const mapper1 = new UrlMapper({
    typeAlias: /[\w\-]+/,
    companyId: /\d+/,
});

const mapper2 = new UrlMapper({
    typeAlias: /[\w\-]+/,
    page: /\d+/,
});

mapper1.connect('/{typeAlias};c{comapnyId}');
mapper2.connect('/{typeAlias};p{page}.html');

const App = () => (
    <BrowserRouter>
        <UrlMapperRouter defaultComponent={Page404}>
            <Mapper mapper={mapper1} component={Comp1} />
            <Mapper mapper={mapper2} component={Comp2} />
            <Mapper path="/test-path" component={Comp3} />
            <Mapper path="/path-with-params/:params" component={Comp4} />
        </UrlMapperRouter>
    </BrowserRouter>
)

Получение шаблонных параметров из url

Самый простой способ получения параметров - воспользоваться hook-ом:

import React from 'react';
import { useMapper } from '@evo/urlmapper-router';

const Comp1 = () => {
    // params - параметры, полученные из шаблонов
    // query - GET параметры
    // mapper - инстанc UrlMapper-а (можно использовать для генерации урлов см. ниже)
    // mapper только для урлов созданных спомощью const mapper1 = new UrlMapper(...)
    const { params, mapper, query } = useMapper();
    return (
        <div>{urlMapper.params}</div> 
    )
}

Так-же можно воспользоваться контекстом

import React from 'react';
import { UrlMapperContext } from '@evo/urlmapper-router';

const Comp1 = () => {
    const { urlMapper } = React.useContext(UrlMapperContext);
    return (
        <div>{urlMapper.params}</div> 
    )
}

Или HOC

import React from 'react';
import { withMapper } from '@evo/urlmapper-router';

const Comp1 = withMapper(({ params }) => {
    return (
        <div>{params}</div> 
    )
})

Генерация url

import React from 'react';
import { useMapper } from '@evo/urlmapper-router';

const Comp1 = () => {
    const { mapper } = useMapper();
    const newUrl = mapper.url('/services;c123', { companyId: 111 }); // /services;c111
    return (
        <div>{newUrl}</div> 
    )
}

useUrl

import React from 'react';
import { useUrl } from '@evo/urlmapper-router';

const Comp1 = () => {
    const { urlCurrent } = useUrl();
    const newUrl = urlCurrent({ params: { companyId: 111 } }); // /services;c111
    // const newUrl = urlCurrent({ params: { companyId: 111 }, absolute: true }); // https://current.origin.com/services;c111
    // const newUrl = urlCurrent({ skipSearch: true }); // will skip search
    return (
        <div>{newUrl}</div> 
    )
}

urlCurrent(opts)

  • opts.params - params to add or modify (GET or template params)
  • opts.absolute - generate absolute link
  • opts.skipSearch - will omit GET parameters

UrlMapperContext

{
    urlMapper: {
        mapper: <url mapper instance>,
        params: <parsed template params>,
        query: <parsed GET params>,
        match: <regex match result>
    }
}