# @evo/urlmapper-router

> Router that uses urlmapper

Latest version **1.1.2** (published 2026-11-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @evo/urlmapper-router
pnpm add @evo/urlmapper-router
yarn add @evo/urlmapper-router
bun add @evo/urlmapper-router
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2026-11-19 |
| First published | 2019-03-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | lequan, zemlanin, alexander, seedofjoy, 041616, docccdev, orhideous, tailhook, hunson.abadeer, mark_tven, amostovenko, sadkovoy, himiranov, evo-kazymyrov, stoyanovk, m.kindritskiy.smartweb |

## Links

- npm: https://www.npmjs.com/package/@evo/urlmapper-router
- Repository: https://gitlab.uaprom/evo-frontend/prom
- npm.io page: https://npm.io/package/@evo/urlmapper-router

## Recent versions

- 1.1.2 (latest) — 2026-11-19
- 1.1.0 — 2025-12-18
- 1.0.9 — 2025-04-03
- 1.0.8 — 2025-04-03
- 1.0.7 — 2025-04-03
- 1.0.6 — 2024-12-23
- 1.0.5 — 2024-12-02
- 1.0.4 — 2024-12-02
- 1.0.3 — 2024-12-02
- 1.0.1 — 2024-06-26
- 1.0.0 — 2024-04-16
- 0.3.5 — 2023-07-12
- 0.3.4 — 2022-02-04
- 0.3.3 — 2020-11-24
- 0.3.2 — 2019-11-06
- … 8 more at https://npm.io/package/@evo/urlmapper-router/versions

## README

# urlmapper-router

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

React компонент для декларативного использвания [urlmapper](https://gitlab.uaprom/evo-frontend/prom/tree/master/packages/urlmapper).

## Установка

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

## Пример:

```jsx
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-ом:

```jsx
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> 
    )
}
```

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

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

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

Или HOC

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

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

# Генерация url

```js
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

```js
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.forceSearchParams* - apply or delete search params (can be used when you have the same name for template param and search param an you want to modify it)
* *opts.skipSearch* - will omit GET parameters

# UrlMapperContext

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

---
_Source: https://npm.io/package/@evo/urlmapper-router · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
